Merge branch 'stable-2.8'

[ganeti-local] / man / gnt-network.rst

diff --git a/man/gnt-network.rst b/man/gnt-network.rst
index a6e325f..c53dbac 100644 (file)
--- a/man/gnt-network.rst
+++ b/man/gnt-network.rst
@@ -14,8 +14,18 @@ Synopsis
 DESCRIPTION
 -----------
 
 DESCRIPTION
 -----------
 

-The **gnt-network** command is used for network definition administration
-in the Ganeti system.
+The **gnt-network** command is used for network definition and
+administration in the Ganeti system. Each instance NIC can be connected
+to a network via the ``network`` NIC parameter. See **gnt-instance**\(8)
+for more details.
+
+BUGS
+----
+
+The ``hail`` iallocator hasn't been updated to take networks into
+account in Ganeti 2.7. The only way to guarantee that it works correctly
+is having your networks connected to all nodegroups. This will be fixed
+in a future version.

 
 COMMANDS
 --------
 
 COMMANDS
 --------

@@ -24,85 +34,91 @@ ADD
 ~~~
 
 | **add**
 ~~~
 
 | **add**

-| [--network=*NETWORK*]
-| [--gateway=*GATEWAY*]
-| [--add-reserved-ips=*RESERVEDIPS*]
-| [--network6=*NETWORK6*]
-| [--gateway6=*GATEWAY6*]
-| [--mac-prefix=*MACPREFIX*]
-| [--network-type=*NETWORKTYPE*]
-| [--submit]
+| [\--network=*NETWORK*]
+| [\--gateway=*GATEWAY*]
+| [\--add-reserved-ips=*RESERVEDIPS*]
+| [\--network6=*NETWORK6*]
+| [\--gateway6=*GATEWAY6*]
+| [\--mac-prefix=*MACPREFIX*]
+| [\--submit]

 | {*network*}
 
 Creates a new network with the given name. The network will be unused
 initially. To connect it to a node group, use ``gnt-network connect``.
 ``--network`` option is mandatory. All other are optional.
 
 | {*network*}
 
 Creates a new network with the given name. The network will be unused
 initially. To connect it to a node group, use ``gnt-network connect``.
 ``--network`` option is mandatory. All other are optional.
 

-The ``--network`` option allows you to specify the network in a CIDR notation.
+The ``--network`` option allows you to specify the network in a CIDR
+notation.

 
 

-The ``--gateway`` option allows you to specify the default gateway for this
-network.
-
-The ``--network-type`` can be none, private or public.
+The ``--gateway`` option allows you to specify the default gateway for
+this network.

 
 IPv6 semantics can be assigned to the network via the ``--network6`` and
 
 IPv6 semantics can be assigned to the network via the ``--network6`` and

-``--gateway6`` options. IP pool is meaningless for IPV6 so those two values
-can be used for EUI64 generation from a NIC's MAC address.
+``--gateway6`` options. IP pool is meaningless for IPV6 so those two
+values can be used for EUI64 generation from a NIC's MAC address.
+
+Note that a when connecting a network to a node group (see below) you
+can specify also the NIC mode and link that will be used by instances on
+that group to physically connect to this network. This allows the system
+to work even if the parameters (eg. the VLAN number) change between
+groups.

 
 

-See **ganeti(7)** for a description of ``--submit`` and other common options.
+See **ganeti**\(7) for a description of ``--submit`` and other common
+options.

 
 MODIFY
 ~~~~~~
 
 | **modify**
 
 MODIFY
 ~~~~~~
 
 | **modify**

-| [--gateway=*GATEWAY*]
-| [--add-reserved-ips=*RESERVEDIPS*]
-| [--remove-reserved-ips=*RESERVEDIPS*]
-| [--network6=*NETWORK6*]
-| [--gateway6=*GATEWAY6*]
-| [--mac-prefix=*MACPREFIX*]
-| [--network-type=*NETWORKTYPE*]
-| [--submit]
+| [\--gateway=*GATEWAY*]
+| [\--add-reserved-ips=*RESERVEDIPS*]
+| [\--remove-reserved-ips=*RESERVEDIPS*]
+| [\--network6=*NETWORK6*]
+| [\--gateway6=*GATEWAY6*]
+| [\--mac-prefix=*MACPREFIX*]
+| [\--submit]

 | {*network*}
 
 Modifies parameters from the network.
 
 | {*network*}
 
 Modifies parameters from the network.
 

-Unable to modify network (IP address range). Create a new network if you want
-to do so. All other options are documented in the **add** command above.
+Unable to modify network (IP address range). Create a new network if you
+want to do so. All other options are documented in the **add** command
+above.

 
 

-See **ganeti(7)** for a description of ``--submit`` and other common options.
+See **ganeti**\(7) for a description of ``--submit`` and other common
+options.

 
 REMOVE
 ~~~~~~
 
 
 REMOVE
 ~~~~~~
 

-| **remove** [--submit] {*network*}
+| **remove** [\--submit] {*network*}

 
 Deletes the indicated network, which must be not connected to any node group.
 
 
 Deletes the indicated network, which must be not connected to any node group.
 

-See **ganeti(7)** for a description of ``--submit`` and other common options.
+See **ganeti**\(7) for a description of ``--submit`` and other common options.

 
 LIST
 ~~~~
 
 
 LIST
 ~~~~
 

-| **list** [--no-headers] [--separator=*SEPARATOR*] [-v]
+| **list** [\--no-headers] [\--separator=*SEPARATOR*] [-v]

 | [-o *[+]FIELD,...*] [network...]
 
 | [-o *[+]FIELD,...*] [network...]
 

-Lists all existing networks in the cluster. If no group names are given, then
-all groups are included. Otherwise, only the named groups will be listed.
+Lists all existing networks in the cluster. If no group names are given,
+then all groups are included. Otherwise, only the named groups will be
+listed.

 
 The ``--no-headers`` option will skip the initial header line. The
 
 The ``--no-headers`` option will skip the initial header line. The

-``--separator`` option takes an argument which denotes what will be
-used between the output fields. Both these options are to help
-scripting.
+``--separator`` option takes an argument which denotes what will be used
+between the output fields. Both these options are to help scripting.

 
 The ``-v`` option activates verbose mode, which changes the display of
 
 The ``-v`` option activates verbose mode, which changes the display of

-special field states (see **ganeti(7)**).
+special field states (see **ganeti**\(7)).

 
 

-The ``-o`` option takes a comma-separated list of output fields.
-If the value of the option starts with the character ``+``, the new
-fields will be added to the default list. This allows to quickly
-see the default list plus a few other fields, instead of retyping
-the entire list of fields.
+The ``-o`` option takes a comma-separated list of output fields. If the
+value of the option starts with the character ``+``, the new fields will
+be added to the default list. This allows to quickly see the default
+list plus a few other fields, instead of retyping the entire list of
+fields.

 
 The available fields and their meaning are:
 
 
 The available fields and their meaning are:
 

@@ -115,15 +131,33 @@ LIST-FIELDS
 
 List available fields for networks.
 
 
 List available fields for networks.
 

-RENAME
-~~~~~~
+INFO
+~~~~

 
 

-| **rename** {*oldname*} {*newname*}
+| **info** [network...]

 
 

-Renames a given network from *oldname* to *newname*. NOT implemeted yet
+Displays information about a given network.

 
 

-TAGS
-~~~
+CONNECT
+~~~~~~~
+
+| **connect** {*network*} {*mode*} {*link*} [*groups*...]
+
+Connect a network to given node groups (all if not specified) with the
+network parameters *mode* and *link*. Every network interface will
+inherit those parameters if assigned in a network.
+
+DISCONNECT
+~~~~~~~~~~
+
+| **disconnect** {*network*} [*groups*...]
+
+Disconnect a network from given node groups (all if not specified). This
+is possible only if no instance is using the network.
+
+
+Tags
+~~~~

 
 ADD-TAGS
 ^^^^^^^^
 
 ADD-TAGS
 ^^^^^^^^

@@ -151,8 +185,8 @@ REMOVE-TAGS
 
 **remove-tags** [\--from *file*] {*networkname*} {*tag*...}
 
 
 **remove-tags** [\--from *file*] {*networkname*} {*tag*...}
 

-Remove tags from the given network. If any of the tags are not
-existing on the network, the entire operation will abort.
+Remove tags from the given network. If any of the tags are not existing
+on the network, the entire operation will abort.

 
 If the ``--from`` option is given, the list of tags to be removed will
 be extended with the contents of that file (each line becomes a tag). In
 
 If the ``--from`` option is given, the list of tags to be removed will
 be extended with the contents of that file (each line becomes a tag). In

@@ -160,25 +194,8 @@ this case, there is not need to pass tags on the command line (if you
 do, tags from both sources will be removed). A file name of ``-`` will
 be interpreted as stdin.
 
 do, tags from both sources will be removed). A file name of ``-`` will
 be interpreted as stdin.
 

-
-INFO
-~~~~
-
-| **info** [network...]
-
-Displays information about a given network.
-
-CONNECT
-~~~~~~~
-| **connect** {*network*} {*group*} {*mode*} {*link*}
-
-Connect a network to a given nodegroup with the netparams (*mode*, *link*).
-Every nic will inherit those netparams if assigned in a network.
-*group* can be ``all`` if you want to connect to all existing nodegroups
-
-DISCONNECT
-~~~~~~~~~~
-| **disconnect** {*network*} {*group*}
-
-Disconnect a network to a nodegroup. This is possible only if no instance
-is using the network.
+.. vim: set textwidth=72 :
+.. Local Variables:
+.. mode: rst
+.. fill-column: 72
+.. End: