mirror of
https://github.com/SebastianWendel/nixpkgs.git
synced 2024-09-20 12:29:02 +02:00
networking/bonds: fix examples
After the change of the bonding options, the examples were not quite correct. The diff is over-the top because the new `let` needs everything indented. Also add a small docstring to the `networkd` attr in the networking test.
This commit is contained in:
parent
ebeb722e14
commit
22c265182f
|
@ -560,101 +560,102 @@ in
|
||||||
|
|
||||||
};
|
};
|
||||||
|
|
||||||
networking.bonds = mkOption {
|
networking.bonds =
|
||||||
default = { };
|
let
|
||||||
example = literalExample {
|
driverOptionsExample = {
|
||||||
bond0 = {
|
miimon = "100";
|
||||||
interfaces = [ "eth0" "wlan0" ];
|
|
||||||
miimon = 100;
|
|
||||||
mode = "active-backup";
|
mode = "active-backup";
|
||||||
};
|
};
|
||||||
fatpipe.interfaces = [ "enp4s0f0" "enp4s0f1" "enp5s0f0" "enp5s0f1" ];
|
in mkOption {
|
||||||
};
|
default = { };
|
||||||
description = ''
|
example = literalExample {
|
||||||
This option allows you to define bond devices that aggregate multiple,
|
bond0 = {
|
||||||
underlying networking interfaces together. The value of this option is
|
interfaces = [ "eth0" "wlan0" ];
|
||||||
an attribute set. Each attribute specifies a bond, with the attribute
|
driverOptions = driverOptionsExample;
|
||||||
name specifying the name of the bond's network interface
|
|
||||||
'';
|
|
||||||
|
|
||||||
type = with types; attrsOf (submodule {
|
|
||||||
|
|
||||||
options = {
|
|
||||||
|
|
||||||
interfaces = mkOption {
|
|
||||||
example = [ "enp4s0f0" "enp4s0f1" "wlan0" ];
|
|
||||||
type = types.listOf types.str;
|
|
||||||
description = "The interfaces to bond together";
|
|
||||||
};
|
};
|
||||||
|
anotherBond.interfaces = [ "enp4s0f0" "enp4s0f1" "enp5s0f0" "enp5s0f1" ];
|
||||||
driverOptions = mkOption {
|
|
||||||
type = types.attrsOf types.str;
|
|
||||||
default = {};
|
|
||||||
example = literalExample {
|
|
||||||
interfaces = [ "eth0" "wlan0" ];
|
|
||||||
miimon = 100;
|
|
||||||
mode = "active-backup";
|
|
||||||
};
|
|
||||||
description = ''
|
|
||||||
Options for the bonding driver.
|
|
||||||
Documentation can be found in
|
|
||||||
<link xlink:href="https://www.kernel.org/doc/Documentation/networking/bonding.txt" />
|
|
||||||
'';
|
|
||||||
|
|
||||||
};
|
|
||||||
|
|
||||||
lacp_rate = mkOption {
|
|
||||||
default = null;
|
|
||||||
example = "fast";
|
|
||||||
type = types.nullOr types.str;
|
|
||||||
description = ''
|
|
||||||
DEPRECATED, use `driverOptions`.
|
|
||||||
Option specifying the rate in which we'll ask our link partner
|
|
||||||
to transmit LACPDU packets in 802.3ad mode.
|
|
||||||
'';
|
|
||||||
};
|
|
||||||
|
|
||||||
miimon = mkOption {
|
|
||||||
default = null;
|
|
||||||
example = 100;
|
|
||||||
type = types.nullOr types.int;
|
|
||||||
description = ''
|
|
||||||
DEPRECATED, use `driverOptions`.
|
|
||||||
Miimon is the number of millisecond in between each round of polling
|
|
||||||
by the device driver for failed links. By default polling is not
|
|
||||||
enabled and the driver is trusted to properly detect and handle
|
|
||||||
failure scenarios.
|
|
||||||
'';
|
|
||||||
};
|
|
||||||
|
|
||||||
mode = mkOption {
|
|
||||||
default = null;
|
|
||||||
example = "active-backup";
|
|
||||||
type = types.nullOr types.str;
|
|
||||||
description = ''
|
|
||||||
DEPRECATED, use `driverOptions`.
|
|
||||||
The mode which the bond will be running. The default mode for
|
|
||||||
the bonding driver is balance-rr, optimizing for throughput.
|
|
||||||
More information about valid modes can be found at
|
|
||||||
https://www.kernel.org/doc/Documentation/networking/bonding.txt
|
|
||||||
'';
|
|
||||||
};
|
|
||||||
|
|
||||||
xmit_hash_policy = mkOption {
|
|
||||||
default = null;
|
|
||||||
example = "layer2+3";
|
|
||||||
type = types.nullOr types.str;
|
|
||||||
description = ''
|
|
||||||
DEPRECATED, use `driverOptions`.
|
|
||||||
Selects the transmit hash policy to use for slave selection in
|
|
||||||
balance-xor, 802.3ad, and tlb modes.
|
|
||||||
'';
|
|
||||||
};
|
|
||||||
|
|
||||||
};
|
};
|
||||||
|
description = ''
|
||||||
|
This option allows you to define bond devices that aggregate multiple,
|
||||||
|
underlying networking interfaces together. The value of this option is
|
||||||
|
an attribute set. Each attribute specifies a bond, with the attribute
|
||||||
|
name specifying the name of the bond's network interface
|
||||||
|
'';
|
||||||
|
|
||||||
});
|
type = with types; attrsOf (submodule {
|
||||||
};
|
|
||||||
|
options = {
|
||||||
|
|
||||||
|
interfaces = mkOption {
|
||||||
|
example = [ "enp4s0f0" "enp4s0f1" "wlan0" ];
|
||||||
|
type = types.listOf types.str;
|
||||||
|
description = "The interfaces to bond together";
|
||||||
|
};
|
||||||
|
|
||||||
|
driverOptions = mkOption {
|
||||||
|
type = types.attrsOf types.str;
|
||||||
|
default = {};
|
||||||
|
example = literalExample driverOptionsExample;
|
||||||
|
description = ''
|
||||||
|
Options for the bonding driver.
|
||||||
|
Documentation can be found in
|
||||||
|
<link xlink:href="https://www.kernel.org/doc/Documentation/networking/bonding.txt" />
|
||||||
|
'';
|
||||||
|
|
||||||
|
};
|
||||||
|
|
||||||
|
lacp_rate = mkOption {
|
||||||
|
default = null;
|
||||||
|
example = "fast";
|
||||||
|
type = types.nullOr types.str;
|
||||||
|
description = ''
|
||||||
|
DEPRECATED, use `driverOptions`.
|
||||||
|
Option specifying the rate in which we'll ask our link partner
|
||||||
|
to transmit LACPDU packets in 802.3ad mode.
|
||||||
|
'';
|
||||||
|
};
|
||||||
|
|
||||||
|
miimon = mkOption {
|
||||||
|
default = null;
|
||||||
|
example = 100;
|
||||||
|
type = types.nullOr types.int;
|
||||||
|
description = ''
|
||||||
|
DEPRECATED, use `driverOptions`.
|
||||||
|
Miimon is the number of millisecond in between each round of polling
|
||||||
|
by the device driver for failed links. By default polling is not
|
||||||
|
enabled and the driver is trusted to properly detect and handle
|
||||||
|
failure scenarios.
|
||||||
|
'';
|
||||||
|
};
|
||||||
|
|
||||||
|
mode = mkOption {
|
||||||
|
default = null;
|
||||||
|
example = "active-backup";
|
||||||
|
type = types.nullOr types.str;
|
||||||
|
description = ''
|
||||||
|
DEPRECATED, use `driverOptions`.
|
||||||
|
The mode which the bond will be running. The default mode for
|
||||||
|
the bonding driver is balance-rr, optimizing for throughput.
|
||||||
|
More information about valid modes can be found at
|
||||||
|
https://www.kernel.org/doc/Documentation/networking/bonding.txt
|
||||||
|
'';
|
||||||
|
};
|
||||||
|
|
||||||
|
xmit_hash_policy = mkOption {
|
||||||
|
default = null;
|
||||||
|
example = "layer2+3";
|
||||||
|
type = types.nullOr types.str;
|
||||||
|
description = ''
|
||||||
|
DEPRECATED, use `driverOptions`.
|
||||||
|
Selects the transmit hash policy to use for slave selection in
|
||||||
|
balance-xor, 802.3ad, and tlb modes.
|
||||||
|
'';
|
||||||
|
};
|
||||||
|
|
||||||
|
};
|
||||||
|
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
networking.macvlans = mkOption {
|
networking.macvlans = mkOption {
|
||||||
default = { };
|
default = { };
|
||||||
|
|
|
@ -1,4 +1,6 @@
|
||||||
{ system ? builtins.currentSystem, networkd }:
|
{ system ? builtins.currentSystem
|
||||||
|
# bool: whether to use networkd in the tests
|
||||||
|
, networkd }:
|
||||||
|
|
||||||
with import ../lib/testing.nix { inherit system; };
|
with import ../lib/testing.nix { inherit system; };
|
||||||
with pkgs.lib;
|
with pkgs.lib;
|
||||||
|
|
Loading…
Reference in a new issue