code.grnet.gr Git - ganeti-local/blob - man/gnt-group.rst

   1 gnt-group(8) Ganeti | Version @GANETI_VERSION@
   2 ==============================================
   3
   4 Name
   5 ----
   6
   7 gnt-group - Ganeti node-group administration
   8
   9 Synopsis
  10 --------
  11
  12 **gnt-group** {command} [arguments...]
  13
  14 DESCRIPTION
  15 -----------
  16
  17 The **gnt-group** command is used for node group administration in
  18 the Ganeti system.
  19
  20 COMMANDS
  21 --------
  22
  23 ADD
  24 ~~~
  25
  26 | **add** [\--submit]
  27 | [\--node-parameters=*NDPARAMS*]
  28 | [\--alloc-policy=*POLICY*]
  29 | [{-D|\--disk-parameters} *disk-template*:*disk-param*=*value*[,*disk-param*=*value*...]]
  30 | [\--specs-cpu-count *spec-param*=*value* [,*spec-param*=*value*...]]
  31 | [\--specs-disk-count *spec-param*=*value* [,*spec-param*=*value*...]]
  32 | [\--specs-disk-size *spec-param*=*value* [,*spec-param*=*value*...]]
  33 | [\--specs-mem-size *spec-param*=*value* [,*spec-param*=*value*...]]
  34 | [\--specs-nic-count *spec-param*=*value* [,*spec-param*=*value*...]]
  35 | [\--ipolicy-bounds-specs *bound_ispecs*]
  36 | [\--ipolicy-disk-templates *template* [,*template*...]]
  37 | [\--ipolicy-spindle-ratio *ratio*]
  38 | [\--ipolicy-vcpu-ratio *ratio*]
  39 | [\--disk-state *diskstate*]
  40 | [\--hypervisor-state *hvstate*]
  41 | {*group*}
  42
  43 Creates a new group with the given name. The node group will be
  44 initially empty; to add nodes to it, use ``gnt-group assign-nodes``.
  45
  46 The ``--node-parameters`` option allows you to set default node
  47 parameters for nodes in the group. Please see **ganeti**\(7) for more
  48 information about supported key=value pairs and their corresponding
  49 options.
  50
  51 The ``--alloc-policy`` option allows you to set an allocation policy for
  52 the group at creation time. Possible values are:
  53
  54 unallocable
  55     nodes in the group should not be candidates for instance allocation,
  56     and the operation (e.g., instance creation) should fail if only
  57     groups in this state could be found to satisfy the requirements.
  58
  59 last_resort
  60     nodes in the group should not be used for instance allocations,
  61     unless this would be the only way to have the operation succeed.
  62
  63 preferred
  64     nodes in the group can be used freely for allocation of instances
  65     (this is the default). Note that prioritization among groups in this
  66     state will be deferred to the iallocator plugin that's being used.
  67
  68 The ``-D (--disk-parameters)`` option allows you to set the disk
  69 parameters for the node group; please see the section about
  70 **gnt-cluster add** in **gnt-cluster**\(8) for more information about
  71 disk parameters
  72
  73 The ``--specs-...`` and ``--ipolicy-...`` options specify instance
  74 policies on the node group, and are documented in the
  75 **gnt-cluster**\(8) man page.
  76
  77 See **ganeti**\(7) for a description of ``--submit`` and other common
  78 options.
  79
  80 ASSIGN-NODES
  81 ~~~~~~~~~~~~
  82
  83 | **assign-nodes**
  84 | [\--force] [\--submit]
  85 | {*group*} {*node*...}
  86
  87 Assigns one or more nodes to the specified group, moving them from their
  88 original group (or groups).
  89
  90 By default, this command will refuse to proceed if the move would split
  91 between groups any instance that was not previously split (a split
  92 instance is an instance with a mirrored disk template, e.g. DRBD, that
  93 has the primary and secondary nodes in different node groups). You can
  94 force the operation with ``--force``.
  95
  96 See **ganeti**\(7) for a description of ``--submit`` and other common
  97 options.
  98
  99 MODIFY
 100 ~~~~~~
 101
 102 | **modify** [\--submit]
 103 | [\--node-parameters=*NDPARAMS*]
 104 | [\--alloc-policy=*POLICY*]
 105 | [\--hypervisor-state *hvstate*]
 106 | [{-D|\--disk-parameters} *disk-template*:*disk-param*=*value*[,*disk-param*=*value*...]]
 107 | [\--disk-state *diskstate*]
 108 | [\--specs-cpu-count *spec-param*=*value* [,*spec-param*=*value*...]]
 109 | [\--specs-disk-count *spec-param*=*value* [,*spec-param*=*value*...]]
 110 | [\--specs-disk-size *spec-param*=*value* [,*spec-param*=*value*...]]
 111 | [\--specs-mem-size *spec-param*=*value* [,*spec-param*=*value*...]]
 112 | [\--specs-nic-count *spec-param*=*value* [,*spec-param*=*value*...]]
 113 | [\--ipolicy-bounds-specs *bound_ispecs*]
 114 | [\--ipolicy-disk-templates *template* [,*template*...]]
 115 | [\--ipolicy-spindle-ratio *ratio*]
 116 | [\--ipolicy-vcpu-ratio *ratio*]
 117 | {*group*}
 118
 119 Modifies some parameters from the node group.
 120
 121 The ``--node-parameters`` and ``--alloc-policy`` options are documented
 122 in the **add** command above. ``--hypervisor-state`` as well as
 123 ``--disk-state`` are documented in detail in **ganeti**\(7).
 124
 125 The ``--node-parameters``, ``--alloc-policy``, ``-D
 126 (--disk-parameters)`` options are documented in the **add** command
 127 above.
 128
 129 The ``--specs-...`` and ``--ipolicy-...`` options specify instance
 130 policies on the node group, and are documented in the
 131 **gnt-cluster**\(8) man page.
 132
 133 See **ganeti**\(7) for a description of ``--submit`` and other common
 134 options.
 135
 136 REMOVE
 137 ~~~~~~
 138
 139 | **remove** [\--submit] {*group*}
 140
 141 Deletes the indicated node group, which must be empty. There must always be at
 142 least one group, so the last group cannot be removed.
 143
 144 See **ganeti**\(7) for a description of ``--submit`` and other common
 145 options.
 146
 147 LIST
 148 ~~~~
 149
 150 | **list** [\--no-headers] [\--separator=*SEPARATOR*] [-v]
 151 | [-o *[+]FIELD,...*] [\--filter] [group...]
 152
 153 Lists all existing node groups in the cluster.
 154
 155 The ``--no-headers`` option will skip the initial header line. The
 156 ``--separator`` option takes an argument which denotes what will be
 157 used between the output fields. Both these options are to help
 158 scripting.
 159
 160 The ``-v`` option activates verbose mode, which changes the display of
 161 special field states (see **ganeti**\(7)).
 162
 163 The ``-o`` option takes a comma-separated list of output fields.
 164 If the value of the option starts with the character ``+``, the new
 165 fields will be added to the default list. This allows one to quickly
 166 see the default list plus a few other fields, instead of retyping
 167 the entire list of fields.
 168
 169 The available fields and their meaning are:
 170
 171 @QUERY_FIELDS_GROUP@
 172
 173 If exactly one argument is given and it appears to be a query filter
 174 (see **ganeti**\(7)), the query result is filtered accordingly. For
 175 ambiguous cases (e.g. a single field name as a filter) the ``--filter``
 176 (``-F``) option forces the argument to be treated as a filter.
 177
 178 If no group names are given, then all groups are included. Otherwise,
 179 only the named groups will be listed.
 180
 181 LIST-FIELDS
 182 ~~~~~~~~~~~
 183
 184 **list-fields** [field...]
 185
 186 List available fields for node groups.
 187
 188 RENAME
 189 ~~~~~~
 190
 191 | **rename** [\--submit] {*oldname*} {*newname*}
 192
 193 Renames a given group from *oldname* to *newname*.
 194
 195 See **ganeti**\(7) for a description of ``--submit`` and other common
 196 options.
 197
 198
 199 EVACUATE
 200 ~~~~~~~~
 201
 202 **evacuate** [\--submit] [\--iallocator *NAME*] [\--to *GROUP*...] {*group*}
 203
 204 This command will move all instances out of the given node group.
 205 Instances are placed in a new group by an iallocator, either given on
 206 the command line or as a cluster default.
 207
 208 If no specific destination groups are specified using ``--to``, all
 209 groups except the evacuated group are considered.
 210
 211 See **ganeti**\(7) for a description of ``--submit`` and other common
 212 options.
 213
 214 Example::
 215
 216     # gnt-group evacuate -I hail --to rack4 rack1
 217
 218
 219 Tags
 220 ~~~~
 221
 222 ADD-TAGS
 223 ^^^^^^^^
 224
 225 **add-tags** [\--from *file*] {*groupname*} {*tag*...}
 226
 227 Add tags to the given node group. If any of the tags contains invalid
 228 characters, the entire operation will abort.
 229
 230 If the ``--from`` option is given, the list of tags will be extended
 231 with the contents of that file (each line becomes a tag). In this case,
 232 there is not need to pass tags on the command line (if you do, both
 233 sources will be used). A file name of ``-`` will be interpreted as
 234 stdin.
 235
 236 LIST-TAGS
 237 ^^^^^^^^^
 238
 239 **list-tags** {*groupname*}
 240
 241 List the tags of the given node group.
 242
 243 REMOVE-TAGS
 244 ^^^^^^^^^^^
 245
 246 **remove-tags** [\--from *file*] {*groupname*} {*tag*...}
 247
 248 Remove tags from the given node group. If any of the tags are not
 249 existing on the node, the entire operation will abort.
 250
 251 If the ``--from`` option is given, the list of tags to be removed will
 252 be extended with the contents of that file (each line becomes a tag). In
 253 this case, there is not need to pass tags on the command line (if you
 254 do, tags from both sources will be removed). A file name of ``-`` will
 255 be interpreted as stdin.
 256
 257 INFO
 258 ~~~~
 259
 260 **info** [*group*...]
 261
 262 Shows config information for all (or given) groups.
 263
 264 SHOW-ISPECS-CMD
 265 ~~~~~~~~~~~~~~~
 266
 267 **show-ispecs-cmd** [\--include-defaults] [*group*...]
 268
 269 Shows the command line that can be used to recreate the given groups (or
 270 all groups, if none is given) with the same options relative to specs in
 271 the instance policies.
 272
 273 If ``--include-defaults`` is specified, include also the default values
 274 (i.e. the cluster-level settings), and not only the configuration items
 275 that a group overrides.
 276
 277
 278 .. vim: set textwidth=72 :
 279 .. Local Variables:
 280 .. mode: rst
 281 .. fill-column: 72
 282 .. End: