docs/source/importing.rst

   1 Importing a Cluster
   2 ===================
   3
   4 #. Log in as an admin user.
   5 #. Navigate *Clusters -> Add Cluster*
   6 #. Fill out properties and click *save*
   7
   8 When the Cluster is imported into Ganeti Web Manager it will
   9 automatically synchronize. Virtual Machine objects will be created to
  10 match what is found on the Ganeti Cluster. :ref:`permission-tags` will
  11 also be parsed to automatically add permissions for virtual machines.
  12
  13 A cluster can be added with only its hostname and port, but a username
  14 and password for the cluster are required if you want to make changes to
  15 it. Clusters added without a valid username and password appear in
  16 :ref:`cluster-read-only` where you can only change aspects of the
  17 cluster that are local to Ganeti Web Manager's database.
  18
  19 If you're logged in as a cluster admin or superuser you can edit
  20 properties of a cluster by using the "edit" button on the cluster detail
  21 page.
  22
  23 .. warning:: If a cluster is in :ref:`cluster-read-only`, there
  24              will be errors if you try to modify virtual machines or
  25              create new ones.
  26
  27
  28 Synchronizing Clusters
  29 ----------------------
  30
  31 Ganeti Web Manager stores some information about clusters in its
  32 database. Cluster and virtual machine information will
  33 :ref:`refresh automatically <lazy-cache>`, but the list of virtual
  34 machines must be synchronized manually. This can be done by via the
  35 orphans view
  36
  37 #. Main Menu -> Orphans
  38
  39 Clusters are synchronized when the orphans view is visited.
  40
  41 Adding Virtual Machines
  42 -----------------------
  43
  44 To add a virtual machine, select "Create VM" in the toolbar. Only fields
  45 with multiple options will be selectable. For example, if you are unable
  46 to change the cluster to which a VM gets added, it means that there is
  47 only one valid option and cluster is a mandatory field.
  48
  49 -  If the user creating the VM has permissions to do so, the owner will
  50    be that user. If the user does not have create permissions but is a
  51    member of a group that can create VMs, ownership defaults to that
  52    group.
  53 -  Cluster can be chosen from those that the the user creating the VM
  54    has access to.
  55 -  The Hypervisor will generally be dictated by the cluster that you
  56    choose.
  57 -  The instance name must be a fully qualified domain name (FQDN). (e.g.
  58    hostname.example.org)
  59 -  If you uncheck "Start up after creation", you can start the VM
  60    manually on its virtual machine detail page. (click Virtual Machines
  61    in the sidebar, then the VM's name)
  62 -  DNS name check: if checked, sends the name you selected for the VM to
  63    the resolver (e.g. in DNS or /etc/hosts, depending on your setup).
  64    Since the name check is used to compute the IP address this also
  65    enables/disables IP checks (e.g. if the IP is pingable). Uncheck if
  66    using dynamic DNS.
  67 -  Disk Template chooses a layout template from these options:
  68
  69    -  plain - Disk devices will be logical volumes (e.g. LVM)
  70    -  drbd - Disk devices will be DRBD (version8.x) on top of LVM
  71       volumes
  72
  73       -  If drbd is selected, a primary and secondary node will need to
  74          be chosen unless automatic allocation has been selection. DRBD
  75          will allow the virtual machine to use live migration and
  76          failover in case one of the nodes goes offline.
  77
  78    -  file - Disk devices will be regular files (e.g. qcow2)
  79    -  diskless - This creates a virtual machine with no disks. Its
  80       useful for testing only (or other special cases).
  81
  82 -  Operating system to install on the virtual machine. Your choices are
  83    limited to the images configured on the cluster.
  84
  85 General Parameters:
  86
  87 -  Virtual CPUs will be deducted from owner's quota. If the owner field
  88    appears blank and is not selectable, the default owner has been
  89    chosen.
  90 -  Memory is the amount of RAM to give this VM. If no units are given,
  91    megabytes is assumed.
  92 -  Disk size is the amount of owner's disk quota to allot this VM. If no
  93    units are given, megabytes is assumed.
  94 -  Disk type determines the way the disks are presented to the virtual
  95    machine. Options may vary based on cluster's hypervisor settings.
  96 -  More information about NIC Mode, NIC Link, and NIC Type can be found
  97    `here <http://docs.ganeti.org/ganeti/current/html/install.html#configuring-the-network>`_
  98
  99 Hypervisor parameters:
 100
 101 *TODO finish this part*
 102
 103 .. _orphans:
 104
 105 Orphaned Virtual Machines
 106 -------------------------
 107
 108 :ref:`permission-tags` are parsed by virtual machine objects, but
 109 sometimes virtual machines will have no tags. To quickly identify
 110 virtual machines with no admin users, use the orphans view
 111
 112 #. Main Menu -> Orphans
 113
 114 Visiting the orphans view will force a synchronization of all clusters
 115 and display VirtualMachines that do not have any permissions assigned.
 116 You only need to grant permissions directly on virtual machines if you
 117 are granting access to non-admin users.