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<--size nnG>
  80
  81 Specify the amount of disk space to give this guest.  You can use
  82 a number followed by a unit, eg. C<--size 20G>
  83
  84 =item B<--timezone TZ>
  85
  86 Specify the timezone, eg. C<--timezone Europe/London>
  87
  88 =item B<--vcpus N>
  89
  90 Specify the number of virtual CPUs to give to the guest.  The default
  91 is the number of physical CPUs, but not more than 4.
  92
  93 =item B<--viewer>
  94
  95 Open the graphical console immediately after booting the guest.  This is
  96 the same as using the C<mclu viewer> subcommand, but quicker.
  97
  98 =back
  99
 100 =item B<mclu console [host:]guest>
 101
 102 Connect to the serial console console of the named guest.
 103
 104 =item B<mclu destroy [host:]guest>
 105
 106 Destroy the named guest.
 107
 108 Note this permanently deletes the guest and its data.
 109
 110 =item B<mclu list [--active] [--all] [--templates]>
 111
 112 List all active (running) guests and/or templates.  You can use
 113 the following options:
 114
 115 =over 4
 116
 117 =item B<--active>
 118
 119 List only active (running) guests.
 120
 121 =item B<--all>
 122
 123 List active (running) guests, and templates.  This is the default.
 124
 125 =item B<--templates>
 126
 127 List only templates.
 128
 129 =back
 130
 131 =item B<mclu off node|wildcard ...>
 132
 133 Switch the node(s) off.  Wildcards can be used in place of hostnames.
 134
 135 mclu checks that no guests are running on the nodes.  Migrate or shut
 136 down the guests first.
 137
 138 =item B<mclu on node|wildcard ...>
 139
 140 Switch the node(s) on.  Wildcards can be used in place of hostnames.
 141
 142 This requires Wake-on-LAN support, both on the target host and in the
 143 mclu configuration.  mclu must have been compiled with the L<wol(1)>
 144 client installed, and the C<mclu.conf> file must list a MAC address
 145 for each host:
 146
 147  [nodes]
 148  host0 mac=11:22:33:44:55:66
 149  host1 mac=11:22:33:44:55:67
 150
 151 =item B<mclu reboot [host:]guest>
 152
 153 Reboot the guest.
 154
 155 =item B<mclu status>
 156
 157 Display the status of the cloud.  This shows you which nodes are on
 158 and off, and the amount of resources used and free on each node.
 159
 160 =item B<mclu viewer [host:]guest>
 161
 162 Open the graphical console of the guest (using L<virt-viewer(1)>).
 163
 164 =back
 165
 166
 167 =head1 CONFIGURATION FILE
 168
 169
 170
 171
 172
 173 =head1 TEMPLATE FILES
 174
 175
 176
 177
 178 =head1 ENVIRONMENT VARIABLES
 179
 180 =over 4
 181
 182 =item C<MCLU_CONFIG>
 183
 184 May be used to override the default configuration file location
 185 (C</etc/mclu.conf>).  See L</CONFIGURATION FILE> above.
 186
 187 =item C<MCLU_PATH>
 188
 189 The path to the directory that contains template files.  See
 190 L</TEMPLATE FILES> above.
 191
 192 =back
 193
 194 =head1 FILES
 195
 196
 197
 198
 199 =head1 SEE ALSO
 200
 201 L<virt-builder(1)>,
 202 L<http://www.redhat.com/mailman/listinfo/virt-tools-list>
 203
 204 =head1 AUTHORS
 205
 206 Richard W.M. Jones <rjones @ redhat . com>
 207
 208 =head1 COPYRIGHT
 209
 210 (C) Copyright 2014-2015 Red Hat Inc.
 211
 212 This program is free software; you can redistribute it and/or modify
 213 it under the terms of the GNU General Public License as published by
 214 the Free Software Foundation; either version 2 of the License, or
 215 (at your option) any later version.
 216
 217 This program is distributed in the hope that it will be useful,
 218 but WITHOUT ANY WARRANTY; without even the implied warranty of
 219 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 220 GNU General Public License for more details.
 221
 222 You should have received a copy of the GNU General Public License
 223 along with this program; if not, write to the Free Software
 224 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.