mclu_boot.ml

   1 (* mclu: Mini Cloud
   2  * Copyright (C) 2014-2015 Red Hat Inc.
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  17  *)
  18
  19 (* Implement 'mclu boot'. *)
  20
  21 module C = Libvirt.Connect
  22 module D = Libvirt.Domain
  23 module MS = Mclu_status
  24
  25 open Printf
  26
  27 open Utils
  28
  29 let memory = ref 0L                     (* 0 = choose for me *)
  30 let set_memory s =
  31   try memory := bytes_of_human_size s
  32   with Not_found ->
  33     eprintf "mclu: don't understand --memory parameter '%s'
  34 Try something like --memory 1G\n" s;
  35     exit 1
  36 let size = ref 0L                       (* 0 = default *)
  37 let set_size s =
  38   try size := bytes_of_human_size s
  39   with Not_found ->
  40     eprintf "mclu: don't understand --size parameter '%s'
  41 Try something like --size 20G\n" s;
  42     exit 1
  43 let timezone = ref ""                   (* "" = no timezone set *)
  44 let vcpus = ref 0                       (* 0 = choose for me *)
  45
  46 let open_console = ref false
  47 let open_viewer = ref false
  48
  49 let get_arg_speclist () = Arg.align [
  50   "--console",  Arg.Set open_console, " Open the serial console";
  51   "--cpus",     Arg.Set_int vcpus, "n Number of virtual CPUs";
  52   "--memory",   Arg.String set_memory, "nnG Amount of RAM to give guest";
  53   "--ram",      Arg.String set_memory, "nnG Amount of RAM to give guest";
  54   "--size",     Arg.String set_size, "nnG Size of disk to give guest";
  55   "--timezone", Arg.Set_string timezone, "TZ Set timezone of guest";
  56   "--vcpus",    Arg.Set_int vcpus, "n Number of virtual CPUs";
  57   "--viewer",   Arg.Set open_viewer, " Open the graphical console";
  58 ]
  59
  60 let boot ~verbose template name =
  61   let templates = Template.templates () in
  62
  63   (* Does the template exist? *)
  64   let template_filename =
  65     try List.assoc template templates
  66     with Not_found ->
  67       eprintf "mclu: template %s not found
  68 Try `mclu list --templates' to list all known templates.\n" template;
  69       exit 1 in
  70
  71   (* Probe the template for various features. *)
  72   let template_info = Template.probe ~verbose template_filename in
  73
  74   (* Check --size is not too small. *)
  75   let size =
  76     match !size, template_info.Template.minimum_size with
  77     | 0L, None -> 0L               (* virt-builder default *)
  78     | 0L, Some min_size ->         (* go with template minimum size *)
  79       min_size
  80     | size, Some min_size when size < min_size ->
  81       eprintf "mclu: --size parameter is smaller than the minimum specified by the template (%s).\n"
  82         (human_size min_size);
  83       exit 1
  84     | size, _ -> size in           (* go with user-specified size *)
  85
  86   (* Decide how much RAM we will give the guest.  This affects our
  87    * choice of node, so do it early.
  88    *)
  89   let memory = !memory in
  90   let memory =
  91     if memory > 0L then (
  92       (* User requested, just check it's above the minimum. *)
  93       match template_info.Template.minimum_memory with
  94       | None -> memory
  95       | Some min when min > memory ->
  96         eprintf "mclu: minimum memory for this template is %s\n"
  97           (human_size min);
  98         exit 1
  99       | Some _ -> memory
 100     ) else (
 101       (* User didn't request any memory setting, use the recommended. *)
 102       match template_info.Template.recommended_memory with
 103       | Some memory -> memory
 104       | None -> 4L *^ 1024L *^ 1024L *^ 1024L (* 4 GB *)
 105     ) in
 106
 107   (* Check what's running. *)
 108   let summary = MS.node_guest_summary ~verbose () in
 109
 110   (* Did the user request a specific host?  If not, choose one. *)
 111   let hostname, name =
 112     match name_parse name with
 113     | Some hostname, name -> hostname, name
 114     | None, name ->
 115       (* Choose the first host with enough free memory. *)
 116       let nodes = List.filter (
 117         fun { MS.free_memory = free_memory } -> free_memory >= memory
 118       ) summary in
 119       match nodes with
 120       | [] ->
 121         eprintf "mclu: no node with enough free memory found
 122 Try: `mclu status' and `mclu on <node>'\n";
 123         exit 1
 124       | node :: _ ->
 125         let hostname =
 126           node.MS.node_status.MS.node.Mclu_conf.hostname in
 127         hostname, name in
 128
 129   (* Check there isn't a guest with this name running anywhere
 130    * in the cluster already.
 131    *)
 132   List.iter (
 133     fun ({ MS.active_guests = guests } as node) ->
 134       List.iter (
 135         fun { Mclu_list.dom_name = n } ->
 136           if name = n then (
 137             let hostname =
 138               node.MS.node_status.MS.node.Mclu_conf.hostname
 139             in
 140             eprintf "mclu: there is already a guest called '%s' (running on %s)\n"
 141               name hostname;
 142             exit 1
 143           )
 144       ) guests
 145   ) summary;
 146
 147   (* Convert hostname to a specific node, and check it is up. *)
 148   let node =
 149     try List.find (
 150       fun node ->
 151         node.MS.node_status.MS.node.Mclu_conf.hostname = hostname
 152     ) summary
 153     with Not_found ->
 154       eprintf "mclu: no node is called '%s'\n" hostname;
 155       exit 1 in
 156   if not node.MS.node_status.MS.node_on then (
 157     eprintf "mclu: node '%s' is switched off
 158 Try: `mclu on %s'\n" hostname hostname;
 159     exit 1
 160   );
 161
 162   (* Where we upload the template and image on remote. *)
 163   let format, extension = "qcow2", "qcow2" in
 164   let remote_template = sprintf "/tmp/mclu%s.sh" (string_random8 ()) in
 165   let remote_template_wrapper = sprintf "/tmp/mclu%s.sh" (string_random8 ()) in
 166   let remote_image = sprintf "/var/tmp/%s.%s" name extension in
 167
 168   (* Get ready to generate the guest XML. *)
 169   let vcpus = !vcpus in
 170   let vcpus =
 171     if vcpus > 0 then vcpus
 172     else min 4 node.MS.node_status.MS.node_info.C.cpus in
 173   let mac_addr =
 174     sprintf "52:54:00:%02x:%02x:%02x"
 175       (Random.int 256) (Random.int 256) (Random.int 256) in
 176
 177   (* Generate the guest XML.  XXX Quoting. *)
 178   let xml = sprintf "\
 179 <domain type='kvm'>
 180   <name>%s</name>
 181   <memory unit='KiB'>%Ld</memory>
 182   <currentMemory unit='KiB'>%Ld</currentMemory>
 183   <vcpu>%d</vcpu>
 184   <os>
 185     <type>hvm</type>
 186     <boot dev='hd'/>
 187   </os>
 188   <features>
 189     <acpi/>
 190     <apic/>
 191     <pae/>
 192   </features>
 193   <cpu mode='host-model' fallback='allow' />
 194   <clock offset='utc'>
 195     <timer name='rtc' tickpolicy='catchup'/>
 196     <timer name='pit' tickpolicy='delay'/>
 197     <timer name='hpet' present='no'/>
 198   </clock>
 199   <on_poweroff>destroy</on_poweroff>
 200   <on_reboot>restart</on_reboot>
 201   <on_crash>restart</on_crash>
 202   <devices>
 203 " name (memory /^ 1024L) (memory /^ 1024L) vcpus in
 204
 205   let xml = xml ^ sprintf "\
 206   <disk type='file' device='disk'>
 207     <driver name='qemu' type='%s' cache='none' io='native'/>
 208     <source file='%s'/>
 209 " format remote_image in
 210   let xml = xml ^
 211     match template_info.Template.disk_bus with
 212     | Some "ide" ->
 213       "      <target dev='sda' bus='ide'/>\n"
 214     | Some "virtio-scsi" | None ->
 215       "      <target dev='sda' bus='scsi'/>\n"
 216     | Some bus ->
 217       eprintf "mclu: unknown disk-bus: %s\n" bus;
 218       exit 1 in
 219   let xml = xml ^ "\
 220     </disk>
 221 " in
 222
 223   let xml = xml ^
 224     if template_info.Template.disk_bus = Some "virtio-scsi" then
 225       "  <controller type='scsi' index='0' model='virtio-scsi'/>\n"
 226     else
 227       "" in
 228
 229   (* XXX Don't hard-code bridge name here. *)
 230   let network_model =
 231     match template_info with
 232     | { Template.network_model = None } -> "virtio"
 233     | { Template.network_model = Some d } -> d in
 234   let xml = xml ^ sprintf "\
 235     <interface type='bridge'>
 236       <mac address='%s'/>
 237       <source bridge='br0'/>
 238       <model type='%s'/>
 239     </interface>
 240 " mac_addr network_model in
 241
 242   let xml = xml ^ "\
 243     <serial type='pty'>
 244       <target port='0'/>
 245     </serial>
 246     <console type='pty'>
 247       <target type='serial' port='0'/>
 248     </console>
 249     <input type='tablet' bus='usb'/>
 250     <input type='mouse' bus='ps2'/>
 251     <input type='keyboard' bus='ps2'/>
 252     <graphics type='vnc' autoport='yes'/>
 253     <video>
 254       <model type='cirrus' vram='9216' heads='1'/>
 255     </video>
 256   </devices>
 257 </domain>" in
 258
 259   (* Copy the template to remote. *)
 260   let cmd =
 261     sprintf "scp %s root@%s:%s"
 262       (quote template_filename) (quote hostname) remote_template in
 263   if verbose then printf "%s\n%!" cmd;
 264   if Sys.command cmd <> 0 then (
 265     eprintf "mclu: scp template to remote failed\n";
 266     exit 1
 267   );
 268
 269   (* Create a wrapper script that sets the variables and runs the
 270    * template.  This just avoids complex quoting.
 271    *)
 272   let () =
 273     let chan = open_out remote_template_wrapper in
 274     let fpf fs = fprintf chan fs in
 275     fpf "#!/bin/sh\n";
 276     (* XXX Don't hard-code network_bridge here. *)
 277     fpf "export LIBGUESTFS_BACKEND_SETTINGS=network_bridge=br0\n";
 278     fpf "export base_image=%s\n" (quote template_info.Template.base_image);
 279     fpf "export format=%s\n" (quote format);
 280     fpf "export name=%s\n" (quote name);
 281     fpf "export output=%s\n" (quote remote_image);
 282     (match size with
 283     | 0L -> ()
 284     | size -> fpf "export size=%s\n" (quote (sprintf "--size %Ldb" size))
 285     );
 286     (match !timezone with
 287     | "" -> ()
 288     | tz -> fpf "export timezone=%s\n" (quote (sprintf "--timezone %s" tz))
 289     );
 290     fpf "%s build\n" remote_template;
 291     close_out chan;
 292     Unix.chmod remote_template_wrapper 0o755 in
 293
 294   let cmd =
 295     sprintf "scp %s root@%s:%s"
 296       (quote remote_template_wrapper) (quote hostname)
 297       (quote remote_template_wrapper) in
 298   if verbose then printf "%s\n%!" cmd;
 299   if Sys.command cmd <> 0 then (
 300     eprintf "mclu: scp template wrapper to remote failed\n";
 301     exit 1
 302   );
 303
 304   let cmd =
 305     sprintf "ssh root@%s %s" (quote hostname) (quote remote_template_wrapper) in
 306   if verbose then printf "%s\n%!" cmd;
 307   if Sys.command cmd <> 0 then (
 308     eprintf "mclu: remote build failed\n";
 309     exit 1
 310   );
 311
 312   (* Start the guest. *)
 313   let dom =
 314     try
 315       let conn =
 316         let name = node.MS.node_status.MS.node.Mclu_conf.libvirt_uri in
 317         C.connect ~name () in
 318       let dom = D.create_xml conn xml [] in
 319       printf "mclu: %s:%s started\n" hostname (D.get_name dom);
 320       dom
 321     with Libvirt.Virterror msg ->
 322       eprintf "mclu: %s: %s\n" hostname (Libvirt.Virterror.to_string msg);
 323       exit 1 in
 324
 325   (* Graphical console? *)
 326   if !open_viewer then
 327     Mclu_viewer.viewer ~verbose ~host:hostname (D.get_name dom);
 328
 329   (* Serial console?  (Interactive, so run it last) *)
 330   if !open_console then
 331     Mclu_console.console ~verbose ~host:hostname (D.get_name dom)
 332
 333 let run ~verbose = function
 334   | [ template; name ] ->
 335     boot ~verbose template name
 336   | _ ->
 337     eprintf "Usage: mclu boot <template> <[host:]name>\n";
 338     exit 1