documentation: add description for forceAddress parameter
authorLukasz Zajaczkowski <Lukasz.Zajaczkowski@ts.fujitsu.com>
Mon, 1 Aug 2016 10:53:46 +0000 (12:53 +0200)
committerLukasz Zajaczkowski <Lukasz.Zajaczkowski@ts.fujitsu.com>
Tue, 2 Aug 2016 05:33:44 +0000 (07:33 +0200)
Documentation/bridge.md

index dcf52b7..3abe99f 100644 (file)
@@ -18,6 +18,7 @@ If the bridge is missing, the plugin will create one on first use and, if gatewa
        "type": "bridge",
        "bridge": "mynet0",
        "isDefaultGateway": true,
+       "forceAddress": false,
        "ipMasq": true,
        "hairpinMode": true,
        "ipam": {
@@ -34,6 +35,7 @@ If the bridge is missing, the plugin will create one on first use and, if gatewa
 * `bridge` (string, optional): name of the bridge to use/create. Defaults to "cni0".
 * `isGateway` (boolean, optional): assign an IP address to the bridge. Defaults to false.
 * `isDefaultGateway` (boolean, optional): Sets isGateway to true and makes the assigned IP the default route. Defaults to false.
+* `forceAddress` (boolean, optional): Indicates if a new IP address should be set if the previous value has been changed. Defaults to false.
 * `ipMasq` (boolean, optional): set up IP Masquerade on the host for traffic originating from this network and destined outside of it. Defaults to false.
 * `mtu` (integer, optional): explicitly set MTU to the specified value. Defaults to the value chosen by the kernel.
 * `hairpinMode` (boolean, optional): set hairpin mode for interfaces on the bridge. Defaults to false.