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