docs/source/usage/clusters.rst

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