mclu.pod

   1 =head1 NAME
   2
   3  mclu - Mini Cloud, a tiny, sane cloud
   4
   5 =head1 SUMMARY
   6
   7 mclu [-f mclu.conf] [--options] [list|status|boot|...] [...]
   8
   9 mclu --help
  10
  11 =head1 DESCRIPTION
  12
  13
  14
  15
  16
  17
  18 =head1 GLOBAL OPTIONS
  19
  20 =over 4
  21
  22 =item B<--help>
  23
  24 Display brief help message and exit.
  25
  26 =item B<-f mclu.conf>
  27
  28 =item B<--config-file mclu.conf>
  29
  30 Specify the path to the configuration file.  If this command option is
  31 I<not> given, then the environment variable C<MCLU_CONFIG> is used,
  32 and if that environment variable is not set then C</etc/mclu.conf> is
  33 used.
  34
  35 See also: L</CONFIGURATION FILE> below.
  36
  37 =item B<-v>
  38
  39 =item B<--verbose>
  40
  41 Enable verbose / debugging messages.
  42
  43 =item B<-V>
  44
  45 =item B<--version>
  46
  47 Display version number and exit.
  48
  49 =back
  50
  51
  52
  53
  54 =head1 SUBCOMMANDS
  55
  56 =over 4
  57
  58 =item B<mclu boot template [host:]name [--memory ..] [--vcpus ..]>
  59
  60 Boot (create) a new instance from B<template>.  It will be started on
  61 B<host> and named B<name>.  If the C<host:> prefix is not given then
  62 it is started on the first host that has sufficient free memory.
  63
  64 The instance is created by running the template script.  You can
  65 control resources using the following options:
  66
  67 =over 4
  68
  69 =item B<--console>
  70
  71 Open the serial console immediately after booting the guest.  This is
  72 the same as using the C<mclu console> subcommand, but quicker.
  73
  74 =item B<--memory nnG>
  75
  76 Specify the amount of memory (RAM) to give this guest.  You can use
  77 a number followed by a unit, eg. C<--memory=4G>
  78
  79 =item B<--vcpus N>
  80
  81 Specify the number of virtual CPUs to give to the guest.  The default
  82 is the number of physical CPUs, but not more than 4.
  83
  84 =item B<--viewer>
  85
  86 Open the graphical console immediately after booting the guest.  This is
  87 the same as using the C<mclu viewer> subcommand, but quicker.
  88
  89 =back
  90
  91 =item B<mclu console [host:]guest>
  92
  93 Connect to the serial console console of the named guest.
  94
  95 =item B<mclu destroy [host:]guest>
  96
  97 Destroy the named guest.
  98
  99 Note this permanently deletes the guest and its data.
 100
 101 =item B<mclu list [--active] [--all] [--templates]>
 102
 103 List all active (running) guests and/or templates.  You can use
 104 the following options:
 105
 106 =over 4
 107
 108 =item B<--active>
 109
 110 List only active (running) guests.
 111
 112 =item B<--all>
 113
 114 List active (running) guests, and templates.  This is the default.
 115
 116 =item B<--templates>
 117
 118 List only templates.
 119
 120 =back
 121
 122 =item B<mclu off node|wildcard ...>
 123
 124 Switch the node(s) off.  Wildcards can be used in place of hostnames.
 125
 126 mclu checks that no guests are running on the nodes.  Migrate or shut
 127 down the guests first.
 128
 129 =item B<mclu on node|wildcard ...>
 130
 131 Switch the node(s) on.  Wildcards can be used in place of hostnames.
 132
 133 This requires Wake-on-LAN support, both on the target host and in the
 134 mclu configuration.  mclu must have been compiled with the L<wol(1)>
 135 client installed, and the C<mclu.conf> file must list a MAC address
 136 for each host:
 137
 138  [nodes]
 139  host0 mac=11:22:33:44:55:66
 140  host1 mac=11:22:33:44:55:67
 141
 142 =item B<mclu reboot [host:]guest>
 143
 144 Reboot the guest.
 145
 146 =item B<mclu status>
 147
 148 Display the status of the cloud.  This shows you which nodes are on
 149 and off, and the amount of resources used and free on each node.
 150
 151 =item B<mclu viewer [host:]guest>
 152
 153 Open the graphical console of the guest (using L<virt-viewer(1)>).
 154
 155 =back
 156
 157
 158 =head1 CONFIGURATION FILE
 159
 160
 161
 162
 163
 164 =head1 TEMPLATE FILES
 165
 166
 167
 168
 169 =head1 ENVIRONMENT VARIABLES
 170
 171 =over 4
 172
 173 =item C<MCLU_CONFIG>
 174
 175 May be used to override the default configuration file location
 176 (C</etc/mclu.conf>).  See L</CONFIGURATION FILE> above.
 177
 178 =item C<MCLU_PATH>
 179
 180 The path to the directory that contains template files.  See
 181 L</TEMPLATE FILES> above.
 182
 183 =back
 184
 185 =head1 FILES
 186
 187
 188
 189
 190 =head1 SEE ALSO
 191
 192 L<virt-builder(1)>,
 193 L<http://www.redhat.com/mailman/listinfo/virt-tools-list>
 194
 195 =head1 AUTHORS
 196
 197 Richard W.M. Jones <rjones @ redhat . com>
 198
 199 =head1 COPYRIGHT
 200
 201 (C) Copyright 2014-2015 Red Hat Inc.
 202
 203 This program is free software; you can redistribute it and/or modify
 204 it under the terms of the GNU General Public License as published by
 205 the Free Software Foundation; either version 2 of the License, or
 206 (at your option) any later version.
 207
 208 This program is distributed in the hope that it will be useful,
 209 but WITHOUT ANY WARRANTY; without even the implied warranty of
 210 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 211 GNU General Public License for more details.
 212
 213 You should have received a copy of the GNU General Public License
 214 along with this program; if not, write to the Free Software
 215 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.