ganeti_web/templates/virtual_machine/create_help.html

   1 {% load i18n %}
   2 <div id="help-contents">
   3     {# performatted help content that will be copied into the help div #}
   4     <div id="help-owner">
   5         <p>
   6         {% blocktrans %}The owner indicates who this virtual machine belongs to. Resources
   7         used by the virtual machine will be deducted from the owner's
   8         quota.{% endblocktrans %}
   9         </p>
  10         <p>
  11         {% blocktrans %}An owner may be a user or a group.  If you are a member of a group
  12         you may create a virtual machine on behalf of that group.{% endblocktrans %}
  13         </p>
  14         <p>
  15         {% blocktrans %}If your user does not directly have access/permission to a cluster,
  16         it will not have permission to own a virtual machine directly.{% endblocktrans %}
  17         </p>
  18     </div>
  19     <div id="help-cluster">
  20         <p>
  21         {% trans "Which ganeti cluster to deploy the new virtual machine on" %}.
  22         </p>
  23     </div>
  24     <div id="help-hostname">
  25         {% blocktrans %}Fully qualified domain name <i>(<b>FQDN</b>)</i> to assign to this
  26         virtual machine. <i>(e.g. hostname.example.org)</i>{% endblocktrans %}
  27     </div>
  28     <div id="help-hypervisor">
  29         <p>
  30             {% trans "Which hypervisor the new virtual machine will run under" %}.
  31         </p>
  32     </div>
  33     <div id="help-start">
  34         <p>
  35         {% blocktrans %}Uncheck this if you don't want the instance to automatically start
  36         after creation. If you do so, you can start it manually on the
  37         virtual machine detail page.{% endblocktrans %}
  38         </p>
  39     </div>
  40     <div id="help-name_check">
  41         <p>
  42         {% blocktrans %}Check the virtual machine DNS name via the resolver <i>(e.g. in DNS
  43         or /etc/hosts, depending on your setup)</i>. Since the name check
  44         is used to compute the IP address this also enables/disables IP
  45         checks <i>(e.g.  if the IP is pingable)</i>.{% endblocktrans %}
  46         </p>
  47         <p>
  48         {% blocktrans %}This is useful for setups that deploy virtual machines using
  49         dynamic DNS and thus the name is not resolvable yet.{% endblocktrans %}
  50         </p>
  51         <p>
  52         {% blocktrans %}<b>Use with caution!</b> If left unchecked you may run into name/ip
  53         collisions.{% endblocktrans %}
  54         </p>
  55     </div>
  56     <div id="help-iallocator">
  57         <p>
  58         {% blocktrans %}Automatically select primary and secondary node to allocate disks
  59         on.{% endblocktrans %}
  60         </p>
  61         <p>
  62         When selected it will use the cluster default
  63         <a href="http://docs.ganeti.org/ganeti/current/html/iallocator.html">
  64         iallocator</a> (if set by the cluster). The iallocator being used
  65         will be displayed after the checkbox.
  66         </p>
  67     </div>
  68     <div id="help-disk_template">
  69         <p>
  70         {% blocktrans %}Disk layout template for the virtual machine on the cluster node.{% endblocktrans %}
  71         </p>
  72         <p>{% trans "The available choices are" %}:</p>
  73         <ul>
  74             <li>
  75                 <b>plain</b> - {% trans "Disk devices will be logical volumes" %} <i>
  76                 (e.g.  LVM)</i>
  77             </li>
  78             <li>
  79                 <b>drbd</b> - {% trans "Disk devices will be" %}
  80                 <a href="http://www.drbd.org/">DRBD</a> ({% trans "version" %}8.x) {% trans "on top of LVM volumes" %}
  81             </li>
  82             <li>
  83                 <b>file</b> - {% trans "Disk devices will be regular files" %}
  84                 <i>(e.g.  qcow2)</i>
  85             </li>
  86             <li>
  87                 <b>diskless</b> - {% blocktrans %}This creates a virtual machine with no
  88                 disks. Its useful for testing only (or other special
  89                 cases).{% endblocktrans %}
  90             </li>
  91         </ul>
  92         <p>
  93             {% blocktrans %}If drbd is selected, then a primary and secondary node will
  94             need to be chosen unless automatic allocation has been
  95             selection. DRBD will allow the virtual machine to use live
  96             migration and failover in case one of the nodes goes offline.{% endblocktrans %}
  97         </p>
  98     </div>
  99     <div id="help-pnode">
 100         {% blocktrans %}The primary node to use for the virtual machine (in case automatic
 101         allocation is not used).{% endblocktrans %}
 102     </div>
 103     <div id="help-snode">
 104         <p>
 105                 {% blocktrans %}The secondary node to use for the virtual machine (in case
 106             automatic allocation is not used).{% endblocktrans %}
 107         </p>
 108         <p>
 109                 {% trans "This is only required when using the drbd disk template." %}
 110         </p>
 111     </div>
 112     <div id="help-os">
 113         <p>
 114                 {% blocktrans %}Operating system to install on the virtual machine. Your
 115             choices are limited to the images configured on the cluster.{% endblocktrans %}
 116         </p>
 117         <p>
 118                 {% blocktrans %}The text in <b>bold</b> signifies the Ganeti Operating
 119             System Type which may be called debootstrap, image, or some
 120             other type. The text that is selectable is the operating system
 121             (or os-type variant) that the cluster has access to.{% endblocktrans %}
 122         </p>
 123     </div>
 124     <div id="help-os_name">
 125         <p>
 126             {% blocktrans %}This option changes the name of the Virtual Machine's Operating
 127             System. It does <b>not</b> reinstall the Operating System. {% endblocktrans %}
 128         </p>
 129     </div>
 130     <div id="help-vcpus">
 131         <p>{% trans "Number of virtual cpus to allocate to this virtual machine" %}.</p>
 132         <p><b><i>{% trans "This will be deducted from the owner's quota" %}.</i></b></p>
 133     </div>
 134     <div id="help-memory">
 135         <p>
 136                 {% blocktrans %}Amount of ram to allocate to this virtual machine. If no units
 137             are given, megabytes is assumed.{% endblocktrans %}
 138         </p>
 139         <p><b><i>{% trans "This will be deducted from the owner's quota" %}.</i></b></p>
 140     </div>
 141     <div id="help-disk_size">
 142         <p>
 143                 {% blocktrans %}Size of the system disk to allocate to this virtual machine. If
 144             no units are given, megabytes is assumed.{% endblocktrans %}
 145         </p>
 146         <p>
 147             Acceptable Formats:
 148         </p>
 149         <ul>
 150             <li>
 151                 <b>M</b> or MB - (megabytes)
 152             </li>
 153             <li>
 154                 <b>G</b> or GB - (gigabytes)
 155             </li>
 156             <li>
 157                 <b>T</b> or TB - (terabytes)
 158             </li>
 159         </ul>
 160         <p><b><i>{% trans "This will be deducted from the owner's quota" %}.</i></b></p>
 161     </div>
 162     <div id="help-disk_type">
 163         <p>
 164                 {% blocktrans %}This parameter determines the way the disks are presented to
 165             the virtual machine.{% endblocktrans %} {%trans "The possible options are" %}:
 166
 167         </p>
 168         <ul>
 169             <li><b>paravirtual</b> - (HVM &amp; KVM)</li>
 170             <li>
 171                 <b>ioemu</b> - (default for HVM &amp; KVM) (HVM &amp; KVM)
 172             </li>
 173             <li><b>ide</b> - (HVM &amp; KVM)</li>
 174             <li><b>scsi</b> - (KVM)</li>
 175             <li><b>sd</b> - (KVM)</li>
 176             <li><b>mtd</b> - (KVM)</li>
 177             <li><b>pflash</b> - (KVM)</li>
 178         </ul>
 179         <p>{% trans "Valid for the Xen HVM and KVM hypervisors" %}.</p>
 180     </div>
 181     <div id="help-nic_mode">
 182         <p>
 183                 {% blocktrans %}This option specifies how the virtual machine connects to the
 184             network. More information on this can be found in the {% endblocktrans %}<a
 185             href="http://docs.ganeti.org/ganeti/current/html/install.html#configuring-the-network">
 186             {% trans "Ganeti tutorial documentation" %}</a>.
 187         </p>
 188         <p>{% trans "When in doubt, choose" %} <b>bridged</b>.</p>
 189         <ul>
 190             <li>
 191                 <b>bridged</b> - {% blocktrans %}The virtual machine's network interface
 192                 will be attached to a software bridge running on the node.{% endblocktrans %}
 193             </li>
 194             <li><b>routed</b> - {% blocktrans %}The virtual machine's network interface
 195                 will be routed{% endblocktrans %}
 196             </li>
 197         </ul>
 198     </div>
 199     <div id="help-nic_link">
 200         <p>
 201             {% blocktrans %}In <b>bridged</b> mode, it specifies the bridge interface to
 202             attach this NIC to on the node <i>(e.g. br0)</i>.{% endblocktrans %}
 203         </p>
 204         <p>
 205                 {% blocktrans %}In <b>routed</b> mode it's intended to differentiate between
 206             different routing tables/virtual machine groups (but the
 207             meaning is dependant on the network script, see
 208             <a href="http://docs.ganeti.org/ganeti/current/man/gnt-cluster.html">
 209             gnt-cluster(8)</a> for more details.{% endblocktrans %}
 210         </p>
 211     </div>
 212     <div id="help-nic_type">
 213         <p>
 214             {% blocktrans %}This parameter determines the way the network cards are
 215             presented to the virtual machine.{% endblocktrans %} {% trans "The possible options are" %}:
 216         </p>
 217         <ul>
 218             <li><b>rtl8139</b> - (default for Xen HVM) (HVM &amp; KVM)</li>
 219             <li><b>ne2k_isa</b> - (HVM &amp; KVM)</li>
 220             <li><b>ne2k_pci</b> - (HVM &amp; KVM)</li>
 221             <li><b>i82551</b> - (KVM)</li>
 222             <li><b>i82557b</b> - (KVM)</li>
 223             <li><b>i82559er</b> - (KVM)</li>
 224             <li><b>pcnet</b> - (KVM)</li>
 225             <li><b>e1000</b> - (KVM)</li>
 226             <li><b>paravirtual</b> - (default for KVM) (KVM &amp; HVM)</li>
 227         </ul>
 228         <p>{% trans "Valid for the Xen PVM and KVM hypervisors" %}.</p>
 229     </div>
 230     <div id="help-nic_mac">
 231         <p>
 232             {% trans "This option specifies a MAC address to be associated with the NIC" %}.
 233         </p>
 234         <p>
 235             {% blocktrans %}Acceptable values are a valid MAC address or 'generate' to
 236             generate a new unique MAC address.{% endblocktrans %}
 237         </p>
 238     </div>
 239     <div id="help-kernel_path">
 240         <p>
 241             {% blocktrans %}This option specifies the path (on the node) to the kernel to
 242             boot the virtual machine with. Xen PVM instances always require
 243             this, while for KVM if this option is empty, it will cause the
 244             machine to load the kernel from its disks.{% endblocktrans %}
 245         </p>
 246         <p>{% trans "Valid for the Xen PVM and KVM hypervisors" %}.</p>
 247     </div>
 248     <div id="help-root_path">
 249         <p>
 250             {% blocktrans %}This option specifies the name of the root device. This is
 251             always needed for Xen PVM, while for KVM it is only used if the
 252             kernel_path option is also specified.{% endblocktrans %}
 253         </p>
 254         <p>{% trans "Valid for the Xen PVM and KVM hypervisors" %}.</p>
 255     </div>
 256     <div id="help-serial_console">
 257         <p>
 258             {% blocktrans %}This boolean option specifies whether to emulate a serial
 259             console for the instance.{% endblocktrans %}
 260         </p>
 261         <p>{% trans "Valid for the KVM hypervisor" %}.</p>
 262     </div>
 263     <div id="help-boot_order">
 264         <p>{% trans "Value denoting boot order for the virtual machine" %}.</p>
 265         <ul>
 266             <li><b>Hard Disk</b> - {% trans "boot from the first disk device" %}</li>
 267             <li>
 268                 <b>CD-ROM</b> - {% blocktrans %}boot from the cdrom (requires CD Image path
 269                 being set){% endblocktrans %}
 270             </li>
 271             <li><b>Network</b> - {% trans "boot from the network (such as PXE)" %}</li>
 272         </ul>
 273         <p>{% trans "Valid for the Xen HVM and KVM hypervisors" %}.</p>
 274     </div>
 275     <div id="help-cdrom_image_path">
 276         <p>
 277            {% blocktrans %}The path to a CDROM image on the node to attach to the virtual
 278            machine.{% endblocktrans %}
 279         </p>
 280         <p>{% trans "Valid for the Xen HVM and KVM hypervisors" %}.</p>
 281     </div>
 282     <div id="help-acpi">
 283         <p>
 284             {% blocktrans %}A boolean option that specifies if the hypervisor should enable
 285             ACPI support for this instance. By default, ACPI is disabled.{% endblocktrans %}
 286         </p>
 287         <p>{% trans "Valid for the Xen HVM and KVM hypervisors" %}.</p>
 288     </div>
 289     <div id="help-disk_cache">
 290         <p>
 291             {% blocktrans %}The disk cache mode. It can be either default to
 292             not pass any cache option to KVM, or one of the KVM  cache
 293             modes.{% endblocktrans %}
 294             {% trans "The possible options are" %}:
 295         </p>
 296         <ul>
 297             <li><b>None</b> - {% trans "For direct I/O" %}</li>
 298             <li> <b>Default</b> - {% trans "No cache option is sent to KVM" %}</li>
 299             <li>
 300                 <b>Writethrough</b> - {% blocktrans %}To use the host cache but
 301                  report completion to the guest only when the
 302                  host has committed the changes to disk{% endblocktrans %}
 303             </li>
 304             <li>
 305                 <b>Writeback</b>
 306                  - {% blocktrans %}To use the host cache and report completion as soon
 307                  as the data is in the host cache{% endblocktrans %}
 308             </li>
 309         </ul>
 310         <p>{% trans "Valid for the KVM hypervisor" %}.</p>
 311     </div>
 312     <div id="help-initrd_path">
 313         <p>
 314             {% blocktrans %}This option specifies the path (on the node) to the initrd
 315             to boot the instance with. Xen PVM instances can use this
 316             always, while for KVM if this option is only used if the
 317             Kernel Path option is also specified.{% endblocktrans %}
 318         </p>
 319         <p>
 320             {% blocktrans %}You can pass here either an absolute filename (the path to
 321             the initrd) if you want to use an initrd, or use the
 322             format no_initrd_path for no initrd.{% endblocktrans %}
 323         </p>
 324         <p>{% trans "Valid for the Xen PVM and KVM hypervisors" %}.</p>
 325     </div>
 326     <div id="help-kernel_args">
 327         <p>
 328             {% blocktrans %}This options specifies extra arguments to the kernel that will
 329             be loaded. device. This is always used for Xen PVM, while for
 330             KVM it is only used if the kernel_path option is also specified.{% endblocktrans %}
 331         </p>
 332         <p>
 333             {% blocktrans %}The default setting for this value is simply "ro", which mounts
 334             the root disk (initially) in read-only one. For example, setting
 335             this to single will cause the instance to start in single-user mode.{% endblocktrans %}
 336         </p>
 337         <p>{% trans "Valid for the Xen PVM and KVM hypervisors" %}.</p>
 338     </div>
 339     <div id="help-kvm_flag">
 340         <p>{% blocktrans %}If <b><i>enabled</i></b> the -enable-kvm flag is
 341         passed to kvm. If <b><i>disabled</i></b> -disable-kvm is passed. If
 342         unset no flag is passed, and the default running mode for your kvm
 343         binary will be used.{% endblocktrans %}</p>
 344         <p>{% trans "Valid for the KVM hypervisor." %}</p>
 345     </div>
 346     <div id="help-mem_path">
 347         <p>
 348             {% blocktrans %}This option passes the -mem-path argument to kvm with the path
 349             (on the node) to the mount point of the hugetlbfs file system,
 350             along with the -mem-prealloc argument too.{% endblocktrans %}
 351         </p>
 352         <p>{% trans "Valid for the KVM hypervisor" %}.</p>
 353     </div>
 354     <div id="help-migration_downtime">
 355         <p>
 356             {% blocktrans %}The maximum amount of time (in ms) a KVM instance is allowed to be
 357             frozen during a live migration, in order to copy dirty memory pages.{% endblocktrans %}
 358         </p>
 359         <p>
 360             {% blocktrans %}Default value is 30ms, but you may need to increase this value for
 361             busy instances.{% endblocktrans %}
 362         </p>
 363         <p>
 364             <b>Note</b> : {% trans "This option is only effective with KVM" %}
 365             {% trans "versions" %} >= 87 {% trans "and QEMU-KVM" %}
 366             {% trans "versions" %} >= 0.11.0.
 367         </p>
 368         <p>{% trans "Valid for the KVM hypervisor" %}.</p>
 369     </div>
 370     <div id="help-security_model">
 371         <p>
 372             {% trans "The security model for kvm" %}.
 373             {% trans "The possible options are" %}:
 374         </p>
 375         <ul>
 376             <li><b>None</b> - {% blocktrans %}The default option. Nothing is done and
 377             instances are run as the Ganeti daemon user (normally root).{% endblocktrans %}</li>
 378             <li><b>User</b> - {% blocktrans %}KVM will drop privileges and become the
 379             user specified by the Security Domain parameter.{% endblocktrans %}</li>
 380             <li><b>Pool</b> - {% blocktrans %}A global cluster pool of users will be used,
 381             making sure no two instances share the same user on the
 382             same node.{% endblocktrans %}
 383             (<b>Note</b> : {% trans "This mode is not implemented yet" %}).</li>
 384         </ul>
 385         <p>{% trans "Valid for the KVM hypervisor" %}.</p>
 386     </div>
 387     <div id="help-security_domain">
 388         <p>
 389             {% blocktrans %}Specifies the username to run the instance under. It must
 390             be a valid username existing on the host.{% endblocktrans %}
 391         </p>
 392         <p>{% trans "Valid for the KVM hypervisor" %}.</p>
 393     </div>
 394     <div id="help-usb_mouse">
 395         <p>
 396             {% blocktrans %}This option specifies the usb mouse type to be used. It can be
 397             "mouse" or "tablet". When using VNC it's recommended to set
 398             it to "tablet".{% endblocktrans %}
 399         </p>
 400         <p>{% trans "Valid for the KVM hypervisor" %}.</p>
 401     </div>
 402     <div id="help-use_chroot">
 403         <p>
 404            {% blocktrans %}This boolean option determines wether to run the KVM instance in
 405            a chroot directory.{% endblocktrans %}
 406         </p>
 407         <p>
 408            {% blocktrans %}If it is set to "true", an empty directory is created before
 409            starting the instance and its path is passed via the -chroot flag
 410            to kvm. The directory is removed when the instance is stopped.{% endblocktrans %}
 411         </p>
 412         <p>{% trans "It is set to &quot;false&quot; by default" %}.</p>
 413         <p>{% trans "Valid for the KVM hypervisor" %}.</p>
 414     </div>
 415     <div id="help-use_localtime">
 416         <p>
 417             {% blocktrans %}A boolean option that specifies if the instance should be started
 418             with its clock set to the localtime of the machine (when true) or
 419             to the UTC (When false). The default is false, which is useful
 420             for Linux/Unix machines; for Windows OSes, it is recommended to
 421             enable this parameter.{% endblocktrans %}
 422         </p>
 423         <p>{% trans "Valid for the Xen HVM and KVM hypervisors" %}.</p>
 424     </div>
 425     <div id="help-vnc_bind_address">
 426         <p>
 427             {% blocktrans %}Specifies the address that the VNC listener for this instance should
 428             bind to. Valid values are IPv4 addresses. Use the address 0.0.0.0
 429             to bind to all available interfaces (this is the default) or specify
 430             the address of one of the interfaces on the node to restrict listening
 431             to that interface.{% endblocktrans %}
 432         </p>
 433         <p>{% trans "Valid for the Xen HVM and KVM hypervisors" %}.</p>
 434     </div>
 435     <div id="help-vnc_tls">
 436         <p>
 437             {% trans "A boolean option that dictates if the VNC connection is secured with TLS" %}.
 438         </p>
 439         <p>{% trans "Valid for the KVM hypervisor" %}.</p>
 440     </div>
 441     <div id="help-vnc_x509_path">
 442         <p>
 443             {% blocktrans %}If VNC TLS is enabled, this option specifies the path to the x509
 444             certificate.{% endblocktrans %}
 445         </p>
 446         <p>{% trans "Valid for the KVM hypervisor" %}.</p>
 447     </div>
 448 </div>