X-Git-Url: https://code.grnet.gr/git/ganeti-local/blobdiff_plain/456798ab9ee3f0210cc02143cb44ec633b4e1bfe..735e1318415bdb4eb4201aaccf169544389ad069:/man/gnt-instance.rst diff --git a/man/gnt-instance.rst b/man/gnt-instance.rst index 6a7d187..59ed6f2 100644 --- a/man/gnt-instance.rst +++ b/man/gnt-instance.rst @@ -27,18 +27,19 @@ ADD ^^^ | **add** -| {-t {diskless | file \| plain \| drbd}} +| {-t|--disk-template {diskless | file \| plain \| drbd}} | {--disk=*N*: {size=*VAL* \| adopt=*LV*}[,vg=*VG*][,metavg=*VG*][,mode=*ro\|rw*] -| \| -s *SIZE*} +| \| {-s|--os-size} *SIZE*} | [--no-ip-check] [--no-name-check] [--no-start] [--no-install] | [--net=*N* [:options...] \| --no-nics] -| [-B *BEPARAMS*] -| [-H *HYPERVISOR* [: option=*value*... ]] -| [-O, --os-parameters *param*=*value*... ] +| [{-B|--backend-parameters} *BEPARAMS*] +| [{-H|--hypervisor-parameters} *HYPERVISOR* [: option=*value*... ]] +| [{-O|--os-parameters} *param*=*value*... ] | [--file-storage-dir *dir\_path*] [--file-driver {loop \| blktap}] -| {-n *node[:secondary-node]* \| --iallocator *name*} -| {-o *os-type*} +| {{-n|--node} *node[:secondary-node]* \| {-I|--iallocator} *name*} +| {{-o|--os-type} *os-type*} | [--submit] +| [--ignore-ipolicy] | {*instance*} Creates a new instance on the specified host. The *instance* argument @@ -61,7 +62,7 @@ reuse those volumes (instead of creating new ones) as the instance's disks. Ganeti will rename these volumes to the standard format, and (without installing the OS) will use them as-is for the instance. This allows migrating instances from non-managed mode -(e.q. plain KVM with LVM) to being managed via Ganeti. Note that +(e.g. plain KVM with LVM) to being managed via Ganeti. Please note that this works only for the \`plain' disk template (see below for template details). @@ -93,8 +94,6 @@ option. By default, one NIC is 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): - - mac either a value or 'generate' to generate a new unique MAC @@ -118,20 +117,25 @@ default at cluster level. Alternatively, if no network is desired for the instance, you can prevent the default of one NIC with the ``--no-nics`` option. -The ``-o`` options specifies the operating system to be installed. -The available operating systems can be listed with **gnt-os list**. -Passing ``--no-install`` will however skip the OS installation, -allowing a manual import if so desired. Note that the no-installation -mode will automatically disable the start-up of the instance (without -an OS, it most likely won't be able to start-up successfully). +The ``-o (--os-type)`` option specifies the operating system to be +installed. The available operating systems can be listed with +**gnt-os list**. Passing ``--no-install`` will however skip the OS +installation, allowing a manual import if so desired. Note that the +no-installation mode will automatically disable the start-up of the +instance (without an OS, it most likely won't be able to start-up +successfully). + +The ``-B (--backend-parameters)`` option specifies the backend +parameters for the instance. If no such parameters are specified, the +values are inherited from the cluster. Possible parameters are: -The ``-B`` option specifies the backend parameters for the -instance. If no such parameters are specified, the values are -inherited from the cluster. Possible parameters are: +maxmem + the maximum memory size of the instance; as usual, suffixes can be + used to denote the unit, otherwise the value is taken in mebibytes -memory - the memory size of the instance; as usual, suffixes can be used to - denote the unit, otherwise the value is taken in mebibites +minmem + the minimum memory size of the instance; as usual, suffixes can be + used to denote the unit, otherwise the value is taken in mebibytes vcpus the number of VCPUs to assign to the instance (if this value makes @@ -141,13 +145,23 @@ auto\_balance whether the instance is considered in the N+1 cluster checks (enough redundancy in the cluster to survive a node failure) +always\_failover + ``True`` or ``False``, whether the instance must be failed over + (shut down and rebooted) always or it may be migrated (briefly + suspended) -The ``-H`` option specified the hypervisor to use for the instance -(must be one of the enabled hypervisors on the cluster) and optionally -custom parameters for this instance. If not other options are used -(i.e. the invocation is just -H *NAME*) the instance will inherit the -cluster options. The defaults below show the cluster defaults at -cluster creation time. +Note that before 2.6 Ganeti had a ``memory`` parameter, which was the +only value of memory an instance could have. With the +``maxmem``/``minmem`` change Ganeti guarantees that at least the minimum +memory is always available for an instance, but allows more memory to be +used (up to the maximum memory) should it be free. + +The ``-H (--hypervisor-parameters)`` option specified the hypervisor +to use for the instance (must be one of the enabled hypervisors on the +cluster) and optionally custom parameters for this instance. If not +other options are used (i.e. the invocation is just -H *NAME*) the +instance will inherit the cluster options. The defaults below show the +cluster defaults at cluster creation time. The possible hypervisor options are as follows: @@ -172,7 +186,7 @@ boot\_order n network boot (PXE) - The default is not to set an HVM boot order which is interpreted + The default is not to set an HVM boot order, which is interpreted as 'dc'. For KVM the boot order is either "floppy", "cdrom", "disk" or @@ -183,8 +197,8 @@ boot\_order blockdev\_prefix Valid for the Xen HVM and PVM hypervisors. - Relevant to nonpvops guest kernels, in which the disk device names - are given by the host. Allows to specify 'xvd', which helps run + Relevant to non-pvops guest kernels, in which the disk device names + are given by the host. Allows one to specify 'xvd', which helps run Red Hat based installers, driven by anaconda. floppy\_image\_path @@ -213,15 +227,15 @@ nic\_type This parameter determines the way the network cards are presented to the instance. The possible options are: - rtl8139 (default for Xen HVM) (HVM & KVM) - ne2k\_isa (HVM & KVM) - ne2k\_pci (HVM & KVM) - i82551 (KVM) - i82557b (KVM) - i82559er (KVM) - pcnet (KVM) - e1000 (KVM) - paravirtual (default for KVM) (HVM & KVM) + - rtl8139 (default for Xen HVM) (HVM & KVM) + - ne2k\_isa (HVM & KVM) + - ne2k\_pci (HVM & KVM) + - i82551 (KVM) + - i82557b (KVM) + - i82559er (KVM) + - pcnet (KVM) + - e1000 (KVM) + - paravirtual (default for KVM) (HVM & KVM) disk\_type Valid for the Xen HVM and KVM hypervisors. @@ -276,6 +290,101 @@ vnc\_x509\_path vnc\_x509\_verify Valid for the KVM hypervisor. +spice\_bind + Valid for the KVM hypervisor. + + Specifies the address or interface on which the SPICE server will + listen. Valid values are: + + - IPv4 addresses, including 0.0.0.0 and 127.0.0.1 + - IPv6 addresses, including :: and ::1 + - names of network interfaces + + If a network interface is specified, the SPICE server will be bound + to one of the addresses of that interface. + +spice\_ip\_version + Valid for the KVM hypervisor. + + Specifies which version of the IP protocol should be used by the + SPICE server. + + It is mainly intended to be used for specifying what kind of IP + addresses should be used if a network interface with both IPv4 and + IPv6 addresses is specified via the ``spice_bind`` parameter. In + this case, if the ``spice_ip_version`` parameter is not used, the + default IP version of the cluster will be used. + +spice\_password\_file + Valid for the KVM hypervisor. + + Specifies a file containing the password that must be used when + connecting via the SPICE protocol. If the option is not specified, + passwordless connections are allowed. + +spice\_image\_compression + Valid for the KVM hypervisor. + + Configures the SPICE lossless image compression. Valid values are: + + - auto_glz + - auto_lz + - quic + - glz + - lz + - off + +spice\_jpeg\_wan\_compression + Valid for the KVM hypervisor. + + Configures how SPICE should use the jpeg algorithm for lossy image + compression on slow links. Valid values are: + + - auto + - never + - always + +spice\_zlib\_glz\_wan\_compression + Valid for the KVM hypervisor. + + Configures how SPICE should use the zlib-glz algorithm for lossy image + compression on slow links. Valid values are: + + - auto + - never + - always + +spice\_streaming\_video + Valid for the KVM hypervisor. + + Configures how SPICE should detect video streams. Valid values are: + + - off + - all + - filter + +spice\_playback\_compression + Valid for the KVM hypervisor. + + Configures whether SPICE should compress audio streams or not. + +spice\_use\_tls + Valid for the KVM hypervisor. + + Specifies that the SPICE server must use TLS to encrypt all the + traffic with the client. + +spice\_tls\_ciphers + Valid for the KVM hypervisor. + + Specifies a list of comma-separated ciphers that SPICE should use + for TLS connections. For the format, see man cipher(1). + +spice\_use\_vdagent + Valid for the KVM hypervisor. + + Enables or disables passing mouse events via SPICE vdagent. + acpi Valid for the Xen HVM and KVM hypervisors. @@ -335,6 +444,10 @@ root\_path needed for Xen PVM, while for KVM it is only used if the ``kernel_path`` option is also specified. + Please note, that if this setting is an empty string and the + hypervisor is Xen it will not be written to the Xen configuration + file + serial\_console Valid for the KVM hypervisor. @@ -430,23 +543,37 @@ usb\_mouse "mouse" or "tablet". When using VNC it's recommended to set it to "tablet". +keymap + Valid for the KVM hypervisor. + + This option specifies the keyboard mapping to be used. It is only + needed when using the VNC console. For example: "fr" or "en-gb". + +reboot\_behavior + Valid for Xen PVM, Xen HVM and KVM hypervisors. + + Normally if an instance reboots, the hypervisor will restart it. If + this option is set to ``exit``, the hypervisor will treat a reboot + as a shutdown instead. + + It is set to ``reboot`` by default. + -The ``-O`` (``--os-parameters``) option allows customisation of the OS +The ``-O (--os-parameters)`` option allows customisation of the OS 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 ... +The ``-I (--iallocator)`` option specifies the instance allocator +plugin to use. If you pass in this option the allocator will select +nodes for this instance automatically, so you don't need to pass them +with the ``-n`` option. For more information please refer to the +instance allocator documentation. -The ``--iallocator`` option specifies the instance allocator plugin to -use. If you pass in this option the allocator will select nodes for -this instance automatically, so you don't need to pass them with the -``-n`` option. For more information please refer to the instance -allocator documentation. - -The ``-t`` options specifies the disk layout type for the instance. -The available choices are: +The ``-t (--disk-template)`` options specifies the disk layout type +for the instance. The available choices are: diskless This creates an instance with no disks. Its useful for testing only @@ -462,7 +589,7 @@ drbd Disk devices will be drbd (version 8.x) on top of lvm volumes. -The optional second value of the ``--node`` is used for the drbd +The optional second value of the ``-n (--node)`` is used for the drbd template type and specifies the remote node. If you do not want gnt-instance to wait for the disk mirror to be @@ -503,15 +630,18 @@ The ``--submit`` option is used to send the job to the master daemon but not wait for its completion. The job ID will be shown so that it can be examined via **gnt-job info**. +If ``--ignore-ipolicy`` is given any instance policy violations occuring +during this operation are ignored. + Example:: - # gnt-instance add -t file --disk 0:size=30g -B memory=512 -o debian-etch \ + # gnt-instance add -t file --disk 0:size=30g -B maxmem=512 -o debian-etch \ -n node1.example.com --file-storage-dir=mysubdir instance1.example.com - # gnt-instance add -t plain --disk 0:size=30g -B memory=512 -o debian-etch \ - -n node1.example.com instance1.example.com + # gnt-instance add -t plain --disk 0:size=30g -B maxmem=1024,minmem=512 \ + -o debian-etch -n node1.example.com instance1.example.com # gnt-instance add -t plain --disk 0:size=30g --disk 1:size=100g,vg=san \ - -B memory=512 -o debian-etch -n node1.example.com instance1.example.com - # gnt-instance add -t drbd --disk 0:size=30g -B memory=512 -o debian-etch \ + -B maxmem=512 -o debian-etch -n node1.example.com instance1.example.com + # gnt-instance add -t drbd --disk 0:size=30g -B maxmem=512 -o debian-etch \ -n node1.example.com:node2.example.com instance2.example.com @@ -596,7 +726,7 @@ parameters taken from the cluster defaults):: "iallocator": "dumb", "hypervisor": "xen-hvm", "hvparams": {"acpi": true}, - "backend": {"memory": 512} + "backend": {"maxmem": 512, "minmem": 256} } } @@ -611,7 +741,7 @@ REMOVE ^^^^^^ **remove** [--ignore-failures] [--shutdown-timeout=*N*] [--submit] -{*instance*} +[--force] {*instance*} Remove an instance. This will remove all data from the instance and there is *no way back*. If you are not sure if you use an instance @@ -632,6 +762,8 @@ The ``--submit`` option is used to send the job to the master daemon but not wait for its completion. The job ID will be shown so that it can be examined via **gnt-job info**. +The ``--force`` option is used to skip the interactive confirmation. + Example:: # gnt-instance remove instance1.example.com @@ -642,7 +774,7 @@ LIST | **list** | [--no-headers] [--separator=*SEPARATOR*] [--units=*UNITS*] [-v] -| [-o *[+]FIELD,...*] [instance...] +| [{-o|--output} *[+]FIELD,...*] [--filter] [instance...] Shows the currently configured instances with memory usage, disk usage, the node they are running on, and their run status. @@ -662,168 +794,14 @@ a given output unit. The ``-v`` option activates verbose mode, which changes the display of special field states (see **ganeti(7)**). -The ``-o`` option takes a comma-separated list of output fields. The -available fields and their meaning are: - - -name - the instance name - -os - the OS of the instance - -pnode - the primary node of the instance - -snodes - comma-separated list of secondary nodes for the instance; usually - this will be just one node - -admin\_state - the desired state of the instance (either "yes" or "no" denoting - the instance should run or not) - -disk\_template - the disk template of the instance - -oper\_state - the actual state of the instance; can be one of the values - "running", "stopped", "(node down)" - -status - combined form of ``admin_state`` and ``oper_stat``; this can be one of: - ``ERROR_nodedown`` if the node of the instance is down, ``ERROR_down`` if - the instance should run but is down, ``ERROR_up`` if the instance should be - stopped but is actually running, ``ERROR_wrongnode`` if the instance is - running but not on the primary, ``ADMIN_down`` if the instance has been - stopped (and is stopped) and ``running`` if the instance is set to be - running (and is running) - -oper\_ram - the actual memory usage of the instance as seen by the hypervisor - -oper\_vcpus - the actual number of VCPUs the instance is using as seen by the - hypervisor - -ip - the ip address Ganeti recognizes as associated with the first - instance interface - -mac - the first instance interface MAC address - -nic\_mode - the mode of the first instance NIC (routed or bridged) - -nic\_link - the link of the first instance NIC - -sda\_size - the size of the instance's first disk - -sdb\_size - the size of the instance's second disk, if any - -vcpus - the number of VCPUs allocated to the instance - -tags - comma-separated list of the instances's tags - -serial\_no - the so called 'serial number' of the instance; this is a numeric - field that is incremented each time the instance is modified, and - it can be used to track modifications - -ctime - the creation time of the instance; note that this field contains - spaces and as such it's harder to parse - - if this attribute is not present (e.g. when upgrading from older - versions), then "N/A" will be shown instead - -mtime - the last modification time of the instance; note that this field - contains spaces and as such it's harder to parse - - if this attribute is not present (e.g. when upgrading from older - versions), then "N/A" will be shown instead - -uuid - Show the UUID of the instance (generated automatically by Ganeti) - -network\_port - If the instance has a network port assigned to it (e.g. for VNC - connections), this will be shown, otherwise - will be displayed. - -beparams - A text format of the entire beparams for the instance. It's more - useful to select individual fields from this dictionary, see - below. - -disk.count - The number of instance disks. - -disk.size/N - The size of the instance's Nth disk. This is a more generic form of - the sda\_size and sdb\_size fields. - -disk.sizes - A comma-separated list of the disk sizes for this instance. - -disk\_usage - The total disk space used by this instance on each of its nodes. - This is not the instance-visible disk size, but the actual disk - "cost" of the instance. - -nic.mac/N - The MAC of the Nth instance NIC. - -nic.ip/N - The IP address of the Nth instance NIC. - -nic.mode/N - The mode of the Nth instance NIC - -nic.link/N - The link of the Nth instance NIC - -nic.macs - A comma-separated list of all the MACs of the instance's NICs. - -nic.ips - A comma-separated list of all the IP addresses of the instance's - NICs. - -nic.modes - A comma-separated list of all the modes of the instance's NICs. - -nic.links - A comma-separated list of all the link parameters of the instance's - NICs. - -nic.count - The number of instance nics. - -hv/*NAME* - The value of the hypervisor parameter called *NAME*. For details of - what hypervisor parameters exist and their meaning, see the **add** - command. - -be/memory - The configured memory for the instance. - -be/vcpus - The configured number of VCPUs for the instance. - -be/auto\_balance - Whether the instance is considered in N+1 checks. +The ``-o (--output)`` option takes a comma-separated list of output +fields. The available fields and their meaning are: +@QUERY_FIELDS_INSTANCE@ If the value of the option starts with the character ``+``, the new -field(s) will be added to the default list. This allows to quickly see -the default list plus a few other fields, instead of retyping the +field(s) will be added to the default list. This allows one to quickly +see the default list plus a few other fields, instead of retyping the entire list of fields. There is a subtle grouping about the available output fields: all @@ -835,8 +813,14 @@ remote nodes for the data. This can be helpful for big clusters when you only want some data and it makes sense to specify a reduced set of output fields. -The default output field list is: name, os, pnode, admin\_state, -oper\_state, oper\_ram. +If exactly one argument is given and it appears to be a query filter +(see **ganeti(7)**), the query result is filtered accordingly. For +ambiguous cases (e.g. a single field name as a filter) the ``--filter`` +(``-F``) option forces the argument to be treated as a filter (e.g. +``gnt-instance list -F admin_state``). + +The default output field list is: ``name``, ``os``, ``pnode``, +``admin_state``, ``oper_state``, ``oper_ram``. LIST-FIELDS @@ -871,15 +855,18 @@ MODIFY ^^^^^^ | **modify** -| [-H *HYPERVISOR\_PARAMETERS*] -| [-B *BACKEND\_PARAMETERS*] +| [{-H|--hypervisor-parameters} *HYPERVISOR\_PARAMETERS*] +| [{-B|--backend-parameters} *BACKEND\_PARAMETERS*] +| [{-m|--runtime-memory} *SIZE*] | [--net add*[:options]* \| --net remove \| --net *N:options*] | [--disk add:size=*SIZE*[,vg=*VG*][,metavg=*VG*] \| --disk remove \| | --disk *N*:mode=*MODE*] -| [-t plain | -t drbd -n *new_secondary*] [--no-wait-for-sync] +| [{-t|--disk-template} plain | {-t|--disk-template} drbd -n *new_secondary*] [--no-wait-for-sync] | [--os-type=*OS* [--force-variant]] -| [-O, --os-parameters *param*=*value*... ] +| [{-O|--os-parameters} *param*=*value*... ] +| [--offline \| --online] | [--submit] +| [--ignore-ipolicy] | {*instance*} Modifies the memory size, number of vcpus, ip address, MAC address @@ -887,18 +874,23 @@ 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. -The ``-H``, ``-B`` and ``-O`` options specifies hypervisor, backend -and OS parameter options in the form of name=value[,...]. For details +The ``-H (--hypervisor-parameters)``, ``-B (--backend-parameters)`` +and ``-O (--os-parameters)`` options specifies hypervisor, backend and +OS parameter options in the form of name=value[,...]. For details which options can be specified, see the **add** command. -The ``-t`` option will change the disk template of the instance. -Currently only conversions between the plain and drbd disk templates -are supported, and the instance must be stopped before attempting the -conversion. When changing from the plain to the drbd disk template, a -new secondary node must be specified via the ``-n`` option. The option -``--no-wait-for-sync`` can be used when converting to the ``drbd`` -template in order to make the instance available for startup before -DRBD has finished resyncing. +The ``-t (--disk-template)`` option will change the disk template of +the instance. Currently only conversions between the plain and drbd +disk templates are supported, and the instance must be stopped before +attempting the conversion. When changing from the plain to the drbd +disk template, a new secondary node must be specified via the ``-n`` +option. The option ``--no-wait-for-sync`` can be used when converting +to the ``drbd`` template in order to make the instance available for +startup before DRBD has finished resyncing. + +The ``-m (--runtime-memory)`` option will change an instance's runtime +memory to the given size (in MB if a different suffix is not specified), +by ballooning it up or down to the new value. The ``--disk add:size=``*SIZE* option adds a disk to the instance. The optional ``vg=``*VG* option specifies LVM volume group other than @@ -915,35 +907,46 @@ instance. The available options are the same as in the **add** command of the instance, while the ``--net`` *N*:*options* option will change the parameters of the Nth instance NIC. -The option ``--os-type`` will change the OS name for the instance +The option ``-o (--os-type)`` will change the OS name for the instance (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, unless the ``--force`` option is given. +The ``--online`` and ``--offline`` options are used to transition an +instance into and out of the ``offline`` state. An instance can be +turned offline only if it was previously down. The ``--online`` option +fails if the instance was not in the ``offline`` state, otherwise it +changes instance's state to ``down``. These modifications take effect +immediately. + The ``--submit`` option is used to send the job to the master daemon but not wait for its completion. The job ID will be shown so that it can be examined via **gnt-job info**. -All the changes take effect at the next restart. If the instance is +If ``--ignore-ipolicy`` is given any instance policy violations occuring +during this operation are ignored. + +Most of the changes take effect at the next restart. If the instance is running, there is no effect on the instance. REINSTALL ^^^^^^^^^ -| **reinstall** [-o *os-type*] [--select-os] [-f *force*] +| **reinstall** [{-o|--os-type} *os-type*] [--select-os] [-f *force*] | [--force-multiple] | [--instance \| --node \| --primary \| --secondary \| --all] -| [-O *OS\_PARAMETERS*] [--submit] {*instance*...} +| [{-O|--os-parameters} *OS\_PARAMETERS*] [--submit] {*instance*...} Reinstalls the operating system on the given instance(s). The -instance(s) must be stopped when running this command. If the -``--os-type`` is specified, the operating system is changed. +instance(s) must be stopped when running this command. If the ``-o +(--os-type)`` is specified, the operating system is changed. The ``--select-os`` option switches to an interactive OS reinstall. The user is prompted to select the OS template from the list of -available OS templates. OS parameters can be overridden using ``-O`` -(more documentation for this option under the **add** command). +available OS templates. OS parameters can be overridden using ``-O +(--os-parameters)`` (more documentation for this option under the +**add** command). Since this is a potentially dangerous command, the user will be required to confirm this action, unless the ``-f`` flag is passed. @@ -970,9 +973,10 @@ the next time the instance is started). The IP test can be skipped if the ``--no-ip-check`` option is passed. The ``--no-name-check`` skips the check for the new instance name via -the resolver (e.g. in DNS or /etc/hosts, depending on your -setup). Since the name check is used to compute the IP address, if you -pass this option you must also pass the ``--no-ip-check`` option. +the resolver (e.g. in DNS or /etc/hosts, depending on your setup) and +that the resolved name matches the provided name. Since the name check +is used to compute the IP address, if you pass this option you must also +pass the ``--no-ip-check`` option. The ``--submit`` option is used to send the job to the master daemon but not wait for its completion. The job ID will be shown so that it @@ -986,11 +990,12 @@ STARTUP | **startup** | [--force] [--ignore-offline] -| [--force-multiple] +| [--force-multiple] [--no-remember] | [--instance \| --node \| --primary \| --secondary \| --all \| | --tags \| --node-tags \| --pri-node-tags \| --sec-node-tags] -| [-H ``key=value...``] [-B ``key=value...``] -| [--submit] +| [{-H|--hypervisor-parameters} ``key=value...``] +| [{-B|--backend-parameters} ``key=value...``] +| [--submit] [--paused] | {*name*...} Starts one or more instances, depending on the following options. The @@ -1031,7 +1036,6 @@ four available modes are: will start all instances in the cluster on secondary nodes with the tags given as arguments - Note that although you can pass more than one selection option, the last one wins, so in order to guarantee the desired result, don't pass more than one such option. @@ -1043,25 +1047,37 @@ mark the instance as started even if the primary is not available. The ``--force-multiple`` will skip the interactive confirmation in the case the more than one instance will be affected. -The ``-H`` and ``-B`` options specify temporary hypervisor and backend -parameters that can be used to start an instance with modified -parameters. They can be useful for quick testing without having to -modify an instance back and forth, e.g.:: +The ``--no-remember`` option will perform the startup but not change +the state of the instance in the configuration file (if it was stopped +before, Ganeti will still thinks it needs to be stopped). This can be +used for testing, or for a one shot-start where you don't want the +watcher to restart the instance if it crashes. + +The ``-H (--hypervisor-parameters)`` and ``-B (--backend-parameters)`` +options specify temporary hypervisor and backend parameters that can +be used to start an instance with modified parameters. They can be +useful for quick testing without having to modify an instance back and +forth, e.g.:: - # gnt-instance start -H root_args="single" instance1 - # gnt-instance start -B memory=2048 instance2 + # gnt-instance start -H kernel_args="single" instance1 + # gnt-instance start -B maxmem=2048 instance2 The first form will start the instance instance1 in single-user mode, and the instance instance2 with 2GB of RAM (this time only, unless that is the actual instance memory size already). Note that the values override the instance parameters (and not extend them): an instance -with "root\_args=ro" when started with -H root\_args=single will +with "kernel\_args=ro" when started with -H kernel\_args=single will result in "single", not "ro single". The ``--submit`` option is used to send the job to the master daemon but not wait for its completion. The job ID will be shown so that it can be examined via **gnt-job info**. +The ``--paused`` option is only valid for Xen and kvm hypervisors. This +pauses the instance at the start of bootup, awaiting ``gnt-instance +console`` to unpause it, allowing the entire boot process to be +monitored for debugging. + Example:: # gnt-instance start instance1.example.com @@ -1074,7 +1090,7 @@ SHUTDOWN | **shutdown** | [--timeout=*N*] -| [--force-multiple] [--ignore-offline] +| [--force-multiple] [--ignore-offline] [--no-remember] | [--instance \| --node \| --primary \| --secondary \| --all \| | --tags \| --node-tags \| --pri-node-tags \| --sec-node-tags] | [--submit] @@ -1103,6 +1119,15 @@ can be examined via **gnt-job info**. force the instance to be marked as stopped. This option should be used with care as it can lead to an inconsistent cluster state. +The ``--no-remember`` option will perform the shutdown but not change +the state of the instance in the configuration file (if it was running +before, Ganeti will still thinks it needs to be running). This can be +useful for a cluster-wide shutdown, where some instances are marked as +up and some as down, and you don't want to change the running state: +you just need to disable the watcher, shutdown all instances with +``--no-remember``, and when the watcher is activated again it will +restore the correct runtime state for all instances. + Example:: # gnt-instance shutdown instance1.example.com @@ -1113,7 +1138,7 @@ REBOOT ^^^^^^ | **reboot** -| [--type=*REBOOT-TYPE*] +| [{-t|--type} *REBOOT-TYPE*] | [--ignore-secondaries] | [--shutdown-timeout=*N*] | [--force-multiple] @@ -1123,7 +1148,7 @@ REBOOT | [*name*...] Reboots one or more instances. The type of reboot depends on the value -of ``--type``. A soft reboot does a hypervisor reboot, a hard reboot +of ``-t (--type)``. A soft reboot does a hypervisor reboot, a hard reboot 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 @@ -1165,6 +1190,10 @@ of the instance. To connect to the virtualized "physical" console of a HVM instance, use a VNC client with the connection info from the **info** command. +For Xen/kvm instances, if the instance is paused, this attempts to +unpause the instance after waiting a few seconds for the connection to +the console to be made. + Example:: # gnt-instance console instance1.example.com @@ -1176,17 +1205,17 @@ Disk management REPLACE-DISKS ^^^^^^^^^^^^^ -**replace-disks** [--submit] [--early-release] {-p} [--disks *idx*] -{*instance*} +**replace-disks** [--submit] [--early-release] [--ignore-ipolicy] {-p} +[--disks *idx*] {*instance*} -**replace-disks** [--submit] [--early-release] {-s} [--disks *idx*] -{*instance*} +**replace-disks** [--submit] [--early-release] [--ignore-ipolicy] {-s} +[--disks *idx*] {*instance*} -**replace-disks** [--submit] [--early-release] {--iallocator *name* -\| --new-secondary *NODE*} {*instance*} +**replace-disks** [--submit] [--early-release] [--ignore-ipolicy] +{--iallocator *name* \| -- {*instance*} -**replace-disks** [--submit] [--early-release] {--auto} -{*instance*} +**replace-disks** [--submit] [--early-release] [--ignore-ipolicy] +{--auto} {*instance*} This command is a generalized form for replacing disks. It is currently only valid for the mirrored (DRBD) disk template. @@ -1225,6 +1254,10 @@ disk failure on the current secondary (thus the old storage is already broken) or when the storage on the primary node is known to be fine (thus we won't need the old storage for potential recovery). +The ``--ignore-ipolicy`` let the command ignore instance policy +violations if replace-disks changes groups and the instance would +violate the new groups instance policy. + Note that it is not possible to select an offline or drained node as a new secondary. @@ -1332,26 +1365,31 @@ instance. RECREATE-DISKS ^^^^^^^^^^^^^^ -**recreate-disks** [--submit] [--disks=``indices``] [-n node1:[node2]] - {*instance*} +| **recreate-disks** [--submit] [-n node1:[node2]] +| [--disk=*N*[:[size=*VAL*][,mode=*ro\|rw*]]] {*instance*} -Recreates the disks of the given instance, or only a subset of the -disks (if the option ``disks`` is passed, which must be a -comma-separated list of disk indices, starting from zero). +Recreates all or a subset of disks of the given instance. Note that this functionality should only be used for missing disks; if any of the given disks already exists, the operation will fail. While this is suboptimal, recreate-disks should hopefully not be needed in normal operation and as such the impact of this is low. +If only a subset should be recreated, any number of ``disk`` options can +be specified. It expects a disk index and an optional list of disk +parameters to change. Only ``size`` and ``mode`` can be changed while +recreating disks. To recreate all disks while changing parameters on +a subset only, a ``--disk`` option must be given for every disk of the +instance. + Optionally the instance's disks can be recreated on different nodes. This can be useful if, for example, the original nodes of the instance have gone down (and are marked offline), so we can't recreate on the same nodes. To do this, pass the new node(s) via ``-n`` option, with a syntax similar to the **add** command. The number of nodes passed must equal the number of nodes that the instance currently -has. Note that changing nodes is only allowed for 'all disk' -replacement (when ``--disks`` is not passed). +has. Note that changing nodes is only allowed when all disks are +replaced, e.g. when no ``--disk`` option is passed. The ``--submit`` option is used to send the job to the master daemon but not wait for its completion. The job ID will be shown so that it @@ -1364,10 +1402,14 @@ FAILOVER ^^^^^^^^ **failover** [-f] [--ignore-consistency] [--shutdown-timeout=*N*] -[--submit] {*instance*} +[--submit] [--ignore-ipolicy] {*instance*} -Failover will fail the instance over its secondary node. This works -only for instances having a drbd disk template. +Failover will stop the instance (if running), change its primary node, +and if it was originally running it will start it again (on the new +primary). This only works for instances with drbd template (in which +case you can only fail to the secondary node) and for externally +mirrored templates (shared storage) (which can change to any other +node). Normally the failover will check the consistency of the disks before failing over the instance. If you are trying to migrate instances off @@ -1386,6 +1428,9 @@ The ``--submit`` option is used to send the job to the master daemon but not wait for its completion. The job ID will be shown so that it can be examined via **gnt-job info**. +If ``--ignore-ipolicy`` is given any instance policy violations occuring +during this operation are ignored. + Example:: # gnt-instance failover instance1.example.com @@ -1396,8 +1441,8 @@ MIGRATE **migrate** [-f] {--cleanup} {*instance*} -**migrate** [-f] [--non-live] [--migration-mode=live\|non-live] -{*instance*} +**migrate** [-f] [--allow-failover] [--non-live] +[--migration-mode=live\|non-live] [--ignore-ipolicy] {*instance*} Migrate will move the instance to its secondary node without shutdown. It only works for instances having the drbd8 disk template @@ -1428,30 +1473,43 @@ ignored. The option ``-f`` will skip the prompting for confirmation. +If ``--allow-failover`` is specified it tries to fallback to failover if +it already can determine that a migration won't work (e.g. if the +instance is shut down). Please note that the fallback will not happen +during execution. If a migration fails during execution it still fails. + +If ``--ignore-ipolicy`` is given any instance policy violations occuring +during this operation are ignored. + Example (and expected output):: # gnt-instance migrate instance1 - Migrate will happen to the instance instance1. Note that migration is - **experimental** in this version. This might impact the instance if - anything goes wrong. Continue? + Instance instance1 will be migrated. Note that migration + might impact the instance if anything goes wrong (e.g. due to bugs in + the hypervisor). Continue? y/[n]/?: y + Migrating instance instance1.example.com * checking disk consistency between source and target - * ensuring the target is in secondary mode + * switching node node2.example.com to secondary mode + * changing into standalone mode * changing disks into dual-master mode - - INFO: Waiting for instance instance1 to sync disks. - - INFO: Instance instance1's disks are in sync. + * wait until resync is done + * preparing node2.example.com to accept the instance * migrating instance to node2.example.com - * changing the instance's disks on source node to secondary - - INFO: Waiting for instance instance1 to sync disks. - - INFO: Instance instance1's disks are in sync. - * changing the instance's disks to single-master + * switching node node1.example.com to secondary mode + * wait until resync is done + * changing into standalone mode + * changing disks into single-master mode + * wait until resync is done + * done # MOVE ^^^^ -**move** [-f] [-n *node*] [--shutdown-timeout=*N*] [--submit] +**move** [-f] [--ignore-consistency] +[-n *node*] [--shutdown-timeout=*N*] [--submit] [--ignore-ipolicy] {*instance*} Move will move the instance to an arbitrary node in the cluster. This @@ -1466,15 +1524,39 @@ before forcing the shutdown (e.g. ``xm destroy`` in XEN, killing the kvm process for KVM, etc.). By default two minutes are given to each instance to stop. +The ``--ignore-consistency`` option will make Ganeti ignore any errors +in trying to shutdown the instance on its node; useful if the +hypervisor is broken and you want to recuperate the data. + The ``--submit`` option is used to send the job to the master daemon but not wait for its completion. The job ID will be shown so that it can be examined via **gnt-job info**. +If ``--ignore-ipolicy`` is given any instance policy violations occuring +during this operation are ignored. + Example:: # gnt-instance move -n node3.example.com instance1.example.com +CHANGE-GROUP +~~~~~~~~~~~~ + +**change-group** [--iallocator *NAME*] [--to *GROUP*...] {*instance*} + +This command moves an instance to another node group. The move is +calculated by an iallocator, either given on the command line or as a +cluster default. + +If no specific destination groups are specified using ``--to``, all +groups except the one containing the instance are considered. + +Example:: + + # gnt-instance change-group -I hail --to rack2 inst1.example.com + + TAGS ~~~~ @@ -1512,3 +1594,9 @@ be extended with the contents of that file (each line becomes a tag). In 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. + +.. vim: set textwidth=72 : +.. Local Variables: +.. mode: rst +.. fill-column: 72 +.. End: