Commit 7d713344 authored by Guido Trotter's avatar Guido Trotter
Browse files

Update manpages for NIC parameters


Signed-off-by: default avatarGuido Trotter <ultrotter@google.com>
Reviewed-by: default avatarIustin Pop <iustin@google.com>
parent 5e3d3eb3
......@@ -190,14 +190,26 @@
the instance to use)</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>bridge</term>
<listitem>
<simpara>specifies the bridge to attach this NIC
to</simpara>
</listitem>
</varlistentry>
</variablelist>
<varlistentry>
<term>mode</term>
<listitem>
<simpara>specifies the connection mode for this nic:
routed or bridged.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>link</term>
<listitem>
<simpara>in bridged mode specifies the bridge to attach
this NIC to, in routed mode it's intended to
differentiate between different routing tables/instance
groups (but the meaning is dependent on the network
script)</simpara>
</listitem>
</varlistentry>
</variablelist>
Of these "mode" and "link" are nic parameters, and inherit their
default at cluster level.
</para>
<para>
......
......@@ -213,8 +213,6 @@
<sbr>
<arg>-s <replaceable>secondary_ip</replaceable></arg>
<sbr>
<arg>-b <replaceable>bridge</replaceable></arg>
<sbr>
<arg>-g <replaceable>vg-name</replaceable></arg>
<sbr>
<arg>--master-netdev <replaceable>vg-name</replaceable></arg>
......@@ -233,6 +231,8 @@
<sbr>
<arg>--backend-parameters <replaceable>be-param</replaceable>=<replaceable>value</replaceable><arg rep="repeat" choice="opt">,<replaceable>be-param</replaceable>=<replaceable>value</replaceable></arg></arg>
<sbr>
<arg>--nic-parameters <replaceable>nic-param</replaceable>=<replaceable>value</replaceable><arg rep="repeat" choice="opt">,<replaceable>nic-param</replaceable>=<replaceable>value</replaceable></arg></arg>
<sbr>
<arg choice="req"><replaceable>clustername</replaceable></arg>
</cmdsynopsis>
......@@ -270,11 +270,6 @@
recommended to use a separate network, of course.
</para>
<para>
The <option>-b</option> option specifies the default bridge
for instances.
</para>
<para>
The <option>-g</option> option will let you specify a volume group
different than 'xenvg' for ganeti to use when creating instance disks.
......@@ -425,6 +420,34 @@
<command>add</command> command.
</para>
<para>
The <option>--nic-parameters</option> option allows you to set
the default nic parameters for the cluster. The parameter
format is a comma-separated list of key=value pairs with the
following supported keys:
<variablelist>
<varlistentry>
<term>mode</term>
<listitem>
<para>
The default nic mode, 'routed' or 'bridged'.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>link</term>
<listitem>
<para>
In bridged mode the default NIC bridge. In routed mode
it represents an hypervisor-vif-script dependent value
to allow different instance groups (perhaps via multiple
routing tables)
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect2>
<refsect2>
......@@ -466,6 +489,8 @@
<sbr>
<arg choice="opt">--backend-parameters <replaceable>be-param</replaceable>=<replaceable>value</replaceable><arg rep="repeat" choice="opt">,<replaceable>be-param</replaceable>=<replaceable>value</replaceable></arg></arg>
<sbr>
<arg choice="opt">--nic-parameters <replaceable>nic-param</replaceable>=<replaceable>value</replaceable><arg rep="repeat" choice="opt">,<replaceable>nic-param</replaceable>=<replaceable>value</replaceable></arg></arg>
<sbr>
<arg>-C <replaceable>candidate_pool_size</replaceable></arg>
</cmdsynopsis>
......@@ -477,8 +502,9 @@
<para>
The <option>-g</option>, <option>--no-lvm-storarge</option>,
<option>--enabled-hypervisors</option>,
<option>--hypervisor-parameters</option> and
<option>--backend-parameters</option> options are
<option>--hypervisor-parameters</option>,
<option>--backend-parameters</option> and
<option>--nic-parameters</option> and options are
described in the <command>init</command> command.
</para>
......
......@@ -113,8 +113,8 @@
<para>
Creates a new instance on the specified host. The
<replaceable>instance</replaceable> argument must be in DNS,
but depending on the bridge setup, need not be in the same
network as the nodes in the cluster.
but depending on the bridge/routing setup, need not be in
the same network as the nodes in the cluster.
</para>
<para>
......@@ -149,9 +149,9 @@
<para>
The NICs of the instances can be specified via the
<option>--net</option> option. By default, one NIC is
created for the instance, with a random MAC, and connected
to the default bridge. Each NIC can take up to three
parameters (all optional):
created for the instance, with a random MAC, and set
up according the the cluster level nic parameters.
Each NIC can take these parameters (all optional):
<variablelist>
<varlistentry>
<term>mac</term>
......@@ -170,13 +170,25 @@
</listitem>
</varlistentry>
<varlistentry>
<term>bridge</term>
<term>mode</term>
<listitem>
<simpara>specifies the bridge to attach this NIC
to</simpara>
<simpara>specifies the connection mode for this nic:
routed or bridged.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>link</term>
<listitem>
<simpara>in bridged mode specifies the bridge to attach
this NIC to, in routed mode it's intended to
differentiate between different routing tables/instance
groups (but the meaning is dependent on the network
script)</simpara>
</listitem>
</varlistentry>
</variablelist>
Of these "mode" and "link" are nic parameters, and inherit their
default at cluster level.
</para>
<para>
......@@ -674,7 +686,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term>mac, ip, bridge</term>
<term>mac, ip, mode, link</term>
<listitem>
<simpara>Specifications for the one NIC that will be
created for the instance.</simpara>
......@@ -912,10 +924,18 @@ instance5: 11225
<simpara>the first instance interface MAC address</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>mode</term>
<listitem>
<simpara>the mode of the first instance NIC
(routed or bridged)</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>bridge</term>
<term>link</term>
<listitem>
<simpara>the bridge of the first instance NIC
<simpara>the link of the first instance NIC
</simpara>
</listitem>
</varlistentry>
......@@ -1015,10 +1035,15 @@ instance5: 11225
</listitem>
</varlistentry>
<varlistentry>
<term>nic.bridge/N</term>
<term>nic.mode/N</term>
<listitem>
<simpara>The bridge the Nth instance NIC is attached
to.</simpara>
<simpara>The mode of the Nth instance NIC</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>nic.link/N</term>
<listitem>
<simpara>The link of the Nth instance NIC</simpara>
</listitem>
</varlistentry>
<varlistentry>
......@@ -1036,12 +1061,19 @@ instance5: 11225
</listitem>
</varlistentry>
<varlistentry>
<term>nic.bridges</term>
<term>nic.modes</term>
<listitem>
<simpara>A comma-separated list of all the bridges of the
<simpara>A comma-separated list of all the modes of the
instance's NICs.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>nic.links</term>
<listitem>
<simpara>A comma-separated list of all the link parameters
of the instance's NICs.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>nic.count</term>
<listitem>
......@@ -1176,10 +1208,10 @@ instance5: 11225
<para>
Modifies the memory size, number of vcpus, ip address, MAC
address and/or bridge for an instance. It can also add and
remove disks and NICs to/from the instance. Note that you
need to give at least one of the arguments, otherwise the
command complains.
address and/or nic parameters for an instance. It can also
add and remove disks and NICs to/from the instance. Note
that you need to give at least one of the arguments, otherwise
the command complains.
</para>
<para>
......@@ -1203,8 +1235,8 @@ instance5: 11225
The <option>--net
add:<replaceable>options</replaceable></option> option will
add a new NIC to the instance. The available options are the
same as in the <command>add</command> command (mac, ip,
bridge). The <option>--net remove</option> will remove the
same as in the <command>add</command> command (mac, ip, link,
mode). The <option>--net remove</option> will remove the
last NIC of the instance, while the <option>--net
<replaceable>N</replaceable>:<replaceable>options</replaceable></option>
option will change the parameters of the Nth instance NIC.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment