Synnefo » snf-ganeti

~~~~

| **init**

| [--vg-name *vg-name*]

| [--master-netdev *interface-name*]

| [--no-lvm-storage]

| [--no-etc-hosts]

| [--no-ssh-init]

| [--file-storage-dir *dir*]

| [--enabled-hypervisors *hypervisors*]

| [-t *hypervisor name*]

| [--maintain-node-health {yes \| no}]

| [--uid-pool *user-id pool definition*]

| [--primary-ip-version *version*]

| [--prealloc-wipe-disks {yes \| no}]

| [--node-parameters *ndparams*]

| {*clustername*}

This commands is only run once initially on the first node of the

use.

The cluster can run in two modes: single-home or dual-homed. In the

dual-homed case, the data replication traffic goes over the second

Note that for Ganeti it doesn't matter if the secondary network is

actually a separate physical network, or is done using tunneling,

important that all nodes have this interface because you'll need it

for a master failover.

The ``--no-lvm-storage`` option allows you to initialize the

cluster without lvm support. This means that only instances using

use for storing the instance disk files when using file storage as

backend for instance disks.

The ``--prealloc-wipe-disks`` sets a cluster wide configuration

value for wiping disks prior to allocation. This increases security

on instance level as the instance can't access untouched data from

it's underlying storage.

xen-pvm

    Xen PVM hypervisor

fake

    fake hypervisor for development/testing

Either a single hypervisor name or a comma-separated list of

hypervisor names can be specified. If this option is not specified,

only the xen-pvm hypervisor is enabled by default.

hypervisor specific parameters for the cluster. The format of this

option is the name of the hypervisor, followed by a colon and a

configurable globally (at cluster level):

migration\_port

    This option is only effective with kvm versions >= 78 and qemu-kvm

    versions >= 0.10.0.

backend parameters for the cluster. The parameter format is a

vcpus

    Number of VCPUs to set for an instance by default, must be an

    will be set to true if not specified.

mode

    The default nic mode, 'routed' or 'bridged'.

    network script it is interpreted as a routing table number or

    name.

The option ``--maintain-node-health`` allows to enable/disable

automatic maintenance actions on nodes. Currently these include

automatic shutdown of instances and deactivation of DRBD devices on

parameters for the cluster. Please see **ganeti**(7) for more

information about supported key=value pairs.

LIST-TAGS

~~~~~~~~~

| [--vg-name *vg-name*]

| [--no-lvm-storage]

| [--enabled-hypervisors *hypervisors*]

| [--uid-pool *user-id pool definition*]

| [--add-uids *user-id pool definition*]

| [--remove-uids *user-id pool definition*]

| [--maintain-node-health {yes \| no}]

| [--prealloc-wipe-disks {yes \| no}]

| [--reserved-lvs=*NAMES*]

| [--node-parameters *ndparams*]

| [--master-netdev *interface-name*]

Modify the options for the cluster.

The ``--vg-name``, ``--no-lvm-storarge``, ``--enabled-hypervisors``,

The ``--add-uids`` and ``--remove-uids`` options can be used to

modify the user-id pool by adding/removing a list of user-ids or

To remove all reserved logical volumes, pass in an empty argument

to the option, as in ``--reserved-lvs=`` or ``--reserved-lvs ''``.

QUEUE

~~~~~

^^^

| **add**

| {--disk=*N*: {size=*VAL* \| adopt=*LV*}[,vg=*VG*][,metavg=*VG*][,mode=*ro\|rw*]

| [--no-ip-check] [--no-name-check] [--no-start] [--no-install]

| [--net=*N* [:options...] \| --no-nics]

| [--file-storage-dir *dir\_path*] [--file-driver {loop \| blktap}]

| [--submit]

| {*instance*}

random MAC, and set up according the the cluster level nic

parameters. Each NIC can take these parameters (all optional):

mac

    either a value or 'generate' to generate a new unique MAC

the instance, you can prevent the default of one NIC with the

``--no-nics`` option.

memory

    the memory size of the instance; as usual, suffixes can be used to

    (enough redundancy in the cluster to survive a node failure)

The possible hypervisor options are as follows:

    This parameter determines the way the network cards are presented

    to the instance. The possible options are:

disk\_type

    Valid for the Xen HVM and KVM hypervisors.

    "tablet".

parameters. The actual parameter names and values depends on the OS

being used, but the syntax is the same key=value. For example, setting

a hypothetical ``dhcp`` parameter to yes can be achieved by::

    gnt-instance add -O dhcp=yes ...

diskless

    This creates an instance with no disks. Its useful for testing only

    Disk devices will be drbd (version 8.x) on top of lvm volumes.

template type and specifies the remote node.

If you do not want gnt-instance to wait for the disk mirror to be

| **list**

| [--no-headers] [--separator=*SEPARATOR*] [--units=*UNITS*] [-v]

Shows the currently configured instances with memory usage, disk

usage, the node they are running on, and their run status.

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

special field states (see **ganeti(7)**).

name

    the instance name

^^^^^^

| **modify**

| [--net add*[:options]* \| --net remove \| --net *N:options*]

| [--disk add:size=*SIZE*[,vg=*VG*][,metavg=*VG*] \| --disk remove \|

|  --disk *N*:mode=*MODE*]

| [--os-type=*OS* [--force-variant]]

| [--submit]

| {*instance*}

disks and NICs to/from the instance. Note that you need to give at

least one of the arguments, otherwise the command complains.

which options can be specified, see the **add** command.

The ``--disk add:size=``*SIZE* option adds a disk to the instance. The

optional ``vg=``*VG* option specifies LVM volume group other than

of the instance, while the ``--net`` *N*:*options* option will change

the parameters of the Nth instance NIC.

(without reinstallation). In case an OS variant is specified that is

not found, then by default the modification is refused, unless

``--force-variant`` is passed. An invalid OS will also be refused,

REINSTALL

^^^^^^^^^

| [--force-multiple]

| [--instance \| --node \| --primary \| --secondary \| --all]

Reinstalls the operating system on the given instance(s). The

The ``--select-os`` option switches to an interactive OS reinstall.

The user is prompted to select the OS template from the list of

Since this is a potentially dangerous command, the user will be

required to confirm this action, unless the ``-f`` flag is passed.

| [--force-multiple]

| [--instance \| --node \| --primary \| --secondary \| --all \|

| --tags \| --node-tags \| --pri-node-tags \| --sec-node-tags]

| [--submit]

| {*name*...}

The ``--force-multiple`` will skip the interactive confirmation in the

case the more than one instance will be affected.

    # gnt-instance start -H root_args="single" instance1

    # gnt-instance start -B memory=2048 instance2

^^^^^^

| **reboot**

| [--ignore-secondaries]

| [--shutdown-timeout=*N*]

| [--force-multiple]

| [*name*...]

Reboots one or more instances. The type of reboot depends on the value

does a instance stop, recreates the hypervisor config for the instance

and starts the instance. A full reboot does the equivalent of

**gnt-instance shutdown && gnt-instance startup**.  The default is

ADD

~~~

| [--master-capable=``yes|no``] [--vm-capable=``yes|no``]

| [--node-parameters *ndparams*]

| {*nodename*}

forcibly join the specified host the cluster, not paying attention

to its current status (it could be already in a cluster, etc.)

In case you're readding a node after hardware failure, you can use

the ``--readd`` parameter. In this case, you don't need to pass the

appears to belong to another cluster. This is used during cluster merging, for

example.

The ``vm_capable``, ``master_capable`` and ``ndparams`` options are

described in **ganeti**(7), and are used to set the properties of the

The new location for the instances can be specified in two ways:

  option

  parameter, so each instance will be in turn placed on the (per the

  script) optimal node

Example::

FAILOVER

| **list**

| [--no-headers] [--separator=*SEPARATOR*]

| [node...]

Lists the nodes in the cluster.

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

special field states (see **ganeti(7)**).

name

~~~~~~

| **modify** [-f] [--submit]

| [--master-capable=``yes|no``] [--vm-capable=``yes|no``] [--auto-promote]

| [--node-parameters *ndparams*]

| [--node-powered=``yes|no``]

| {*node*}

yes. The meaning of the roles and flags are described in the

manpage **ganeti**(7).

In case a node is demoted from the master candidate role, the

operation will be refused unless you pass the ``--auto-promote``

    # gnt-node modify --offline=yes node1.example.com

Example (setting the node back to online and master candidate)::

~~~~~~~

| **volumes** [--no-headers] [--human-readable]

| [*node*...]

Lists all logical volumes and their physical disks from the node(s)

parsing by scripts. In both cases, the ``--units`` option can be

used to enforce a given output unit.

node

    the node name on which the volume exists

| **list-storage** [--no-headers] [--human-readable]

| [--separator=*SEPARATOR*] [--storage-type=*STORAGE\_TYPE*]

| [*node*...]

Lists the available storage units and their details for the given

The ``--storage-type`` option can be used to choose a storage unit

type. Possible choices are lvm-pv, lvm-vg or file.

node

    the node name on which the volume exists