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