From 0a7df307d472ecebd10031eaf7e211bca59f7db4 Mon Sep 17 00:00:00 2001 From: Pavel Cahyna Date: Fri, 9 Mar 2018 12:37:02 +0100 Subject: [PATCH 1/5] doc: add a brief description of the dns and dns_search options requested in bz1550128. --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index b845a71..c962c3c 100644 --- a/README.md +++ b/README.md @@ -253,6 +253,13 @@ network_connections: #dhcp4_send_hostname: no gateway4: 192.0.2.1 + dns: + - 192.0.2.2 + - 198.51.100.5 + dns_search: + - example.com + - subdomain.example.com + route_metric6: -1 auto6: no gateway6: 2001:db8::1 @@ -274,6 +281,9 @@ Note that `dhcp4_send_hostname` is only supported by the `nm` provider and trans to [`ipv4.dhcp-send-hostname`](https://developer.gnome.org/NetworkManager/stable/nm-settings.html#nm-settings.property.ipv4.dhcp-send-hostname) property. +Manual DNS configuration can be specified via a list of addresses +`dns` and a list of domains to search `dns_search`. + - For NetworkManager, `route_metric4` and `route_metric6` corresponds to the [`ipv4.route-metric`](https://developer.gnome.org/NetworkManager/stable/nm-settings.html#nm-settings.property.ipv4.route-metric) and [`ipv6.route-metric`](https://developer.gnome.org/NetworkManager/stable/nm-settings.html#nm-settings.property.ipv6.route-metric) From 7e1b2f0117ceb3852806d0c909bcf4b598d2151b Mon Sep 17 00:00:00 2001 From: Pavel Cahyna Date: Fri, 9 Mar 2018 14:42:48 +0100 Subject: [PATCH 2/5] doc: document the static routing related options. --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index c962c3c..4f63fdc 100644 --- a/README.md +++ b/README.md @@ -268,6 +268,18 @@ network_connections: - 192.0.2.3/24 - 198.51.100.3/26 - 2001:db8::80/7 + + route: + - network: 198.51.100.128 + prefix: 26 + gateway: 198.51.100.1 + metric: 2 + - network: 198.51.100.64 + prefix: 26 + gateway: 198.51.100.6 + metric: 4 + route_append_only: no + rule_append_only: yes ``` Manual addressing can be specified via a list of addresses and prefixes `address`. @@ -290,6 +302,19 @@ Manual DNS configuration can be specified via a list of addresses properties, respectively. If specified, it determines the route metric for DHCP assigned routes and the default route, and thus the priority for multiple interfaces. +Static route configuration can be specified via a list of routes given in the `route` +option. The default value is an empty list. Each route is a dictionary with the following +entries: `network`, `prefix`, `gateway` and `metric`. `network` and `prefix` together specify +the destination network. CIDR notation or network mask notation are not supported yet. If the +boolean option `route_append_only` is `True`, the specified routes are appended to the +existing routes, if it is `False` (default), the current routes are replaced. Setting this +option to `True` without setting `route` has the effect of preserving the current static routes. The +boolean option `rule_append_only` works in a similar way for routing rules. Note that there is +no further support for routing rules at the moment, so this option serves merely the purpose +of preserving the current routing rules. Note also that when +`route_append_only`/`rule_append_only` is not specified, the current routes/routing rules will +be deleted by the role. + Slaves to bridge/bond/team devices cannot specify `ip` settings. ### Virtual types and Slaves From 06eb0ff5d39ce8b96716a821deb035eefc25ac88 Mon Sep 17 00:00:00 2001 From: Pavel Cahyna Date: Fri, 9 Mar 2018 15:01:56 +0100 Subject: [PATCH 3/5] doc: document the ethernet specific options. --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 4f63fdc..56f5d67 100644 --- a/README.md +++ b/README.md @@ -317,6 +317,25 @@ be deleted by the role. Slaves to bridge/bond/team devices cannot specify `ip` settings. +### `type: ethernet` + +Ethernet-specific options can be set using the connection profile variable `ethernet`. This +variable should be specified as a dictionary with the following items (options): `autoneg`, `speed` and `duplex`, +which correspond to the settings of the `ethtool` utility with the same name. `speed` is an +integer giving the speed in Mb/s, the valid values of `duplex` are `half` and `full` and +`autoneg` accepts a boolean value. + +```yaml +network_connections: + - name: "eth0" + type: "ethernet" + + ethernet: + autoneg: false + speed: 1000 + duplex: full +``` + ### Virtual types and Slaves Device types like `bridge`, `bond`, `team` work similar: From 0204786c8a1234c308d2567a1d64de475f89e58f Mon Sep 17 00:00:00 2001 From: Pavel Cahyna Date: Fri, 9 Mar 2018 15:02:26 +0100 Subject: [PATCH 4/5] doc: infiniband is a valid connection type as well. --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 56f5d67..f4524e3 100644 --- a/README.md +++ b/README.md @@ -114,6 +114,7 @@ variable. Valid values for `type` are: - `ethernet` + - `infiniband` - `bridge` - `bond` - `team` From 5106cb67e84680a29cc1ec669ff163220eaa2135 Mon Sep 17 00:00:00 2001 From: Pavel Cahyna Date: Wed, 14 Mar 2018 01:39:18 +0100 Subject: [PATCH 5/5] doc: corrections from @tyll: among others, use `yes`/`no` for bools --- README.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index f4524e3..56de889 100644 --- a/README.md +++ b/README.md @@ -295,7 +295,8 @@ to [`ipv4.dhcp-send-hostname`](https://developer.gnome.org/NetworkManager/stable property. Manual DNS configuration can be specified via a list of addresses -`dns` and a list of domains to search `dns_search`. +given in the `dns` option and a list of domains to search given in the +`dns_search` option. - For NetworkManager, `route_metric4` and `route_metric6` corresponds to the [`ipv4.route-metric`](https://developer.gnome.org/NetworkManager/stable/nm-settings.html#nm-settings.property.ipv4.route-metric) and @@ -307,9 +308,9 @@ Static route configuration can be specified via a list of routes given in the `r option. The default value is an empty list. Each route is a dictionary with the following entries: `network`, `prefix`, `gateway` and `metric`. `network` and `prefix` together specify the destination network. CIDR notation or network mask notation are not supported yet. If the -boolean option `route_append_only` is `True`, the specified routes are appended to the -existing routes, if it is `False` (default), the current routes are replaced. Setting this -option to `True` without setting `route` has the effect of preserving the current static routes. The +boolean option `route_append_only` is `yes`, the specified routes are appended to the +existing routes, if it is `no` (default), the current routes are replaced. Setting this +option to `yes` without setting `route` has the effect of preserving the current static routes. The boolean option `rule_append_only` works in a similar way for routing rules. Note that there is no further support for routing rules at the moment, so this option serves merely the purpose of preserving the current routing rules. Note also that when @@ -323,8 +324,8 @@ Slaves to bridge/bond/team devices cannot specify `ip` settings. Ethernet-specific options can be set using the connection profile variable `ethernet`. This variable should be specified as a dictionary with the following items (options): `autoneg`, `speed` and `duplex`, which correspond to the settings of the `ethtool` utility with the same name. `speed` is an -integer giving the speed in Mb/s, the valid values of `duplex` are `half` and `full` and -`autoneg` accepts a boolean value. +integer giving the speed in Mb/s, the valid values of `duplex` are `half` and `full`, and +`autoneg` accepts a boolean value (default is `yes`) to configure autonegotiation. The `speed` and `duplex` settings are required when autonegotiation is disabled. ```yaml network_connections: @@ -332,7 +333,7 @@ network_connections: type: "ethernet" ethernet: - autoneg: false + autoneg: no speed: 1000 duplex: full ```