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