mclu version 2

[mclu.git] / mclu.pod

diff --git a/mclu.pod b/mclu.pod
new file mode 100644 (file)
index 0000000..5c2a03f
--- /dev/null
+++ b/mclu.pod
@@ -0,0 +1,187 @@
+=head1 NAME
+
+ mclu - Mini Cloud, a tiny, sane cloud
+
+=head1 SUMMARY
+
+mclu [-f mclu.conf] [--options] [list|status|boot|...] [...]
+
+mclu --help
+
+=head1 DESCRIPTION
+
+
+
+
+
+
+=head1 GLOBAL OPTIONS
+
+=over 4
+
+=item B<--help>
+
+Display brief help message and exit.
+
+=item B<-f mclu.conf>
+
+=item B<--config-file mclu.conf>
+
+Specify the path to the configuration file.  If this command option is
+I<not> given, then the environment variable C<MCLU_CONFIG> is used,
+and if that environment variable is not set then C</etc/mclu.conf> is
+used.
+
+See also: L</CONFIGURATION FILE> below.
+
+=item B<-v>
+
+=item B<--verbose>
+
+Enable verbose / debugging messages.
+
+=item B<-V>
+
+=item B<--version>
+
+Display version number and exit.
+
+=back
+
+
+
+
+=head1 SUBCOMMANDS
+
+=over 4
+
+=item B<mclu boot template [host:]name [--memory ..] [--vcpus ..]>
+
+Boot (create) a new instance from B<template>.  It will be started on
+B<host> and named B<name>.  If the C<host:> prefix is not given then
+it is started on the first host that has sufficient free memory.
+
+The instance is created by running the template script.  You can
+control resources using the following options:
+
+=over 4
+
+=item B<--memory nnG>
+
+Specify the amount of memory (RAM) to give this guest.  You can use
+a number followed by a unit, eg. C<--memory=4G>
+
+=item B<--vcpus N>
+
+Specify the number of virtual CPUs to give to the guest.  The default
+is the number of physical CPUs, but not more than 4.
+
+=back
+
+=item B<mclu list [--active] [--all] [--templates]>
+
+List all active (running) guests and/or templates.  You can use
+the following options:
+
+=over 4
+
+=item B<--active>
+
+List only active (running) guests.
+
+=item B<--all>
+
+List active (running) guests, and templates.  This is the default.
+
+=item B<--templates>
+
+List only templates.
+
+=back
+
+=item B<mclu off node|wildcard ...>
+
+Switch the node(s) off.  Wildcards can be used in place of hostnames.
+
+mclu checks that no guests are running on the nodes.  Migrate or shut
+down the guests first.
+
+=item B<mclu on node|wildcard ...>
+
+Switch the node(s) on.  Wildcards can be used in place of hostnames.
+
+This requires Wake-on-LAN support, both on the target host and in the
+mclu configuration.  mclu must have been compiled with the L<wol(1)>
+client installed, and the C<mclu.conf> file must list a MAC address
+for each host:
+
+ [nodes]
+ host0 mac=11:22:33:44:55:66
+ host1 mac=11:22:33:44:55:67
+
+=item B<mclu status>
+
+Display the status of the cloud.  This shows you which nodes are on
+and off, and the amount of resources used and free on each node.
+
+=back
+
+
+=head1 CONFIGURATION FILE
+
+
+
+
+
+=head1 TEMPLATE FILES
+
+
+
+
+=head1 ENVIRONMENT VARIABLES
+
+=over 4
+
+=item C<MCLU_CONFIG>
+
+May be used to override the default configuration file location
+(C</etc/mclu.conf>).  See L</CONFIGURATION FILE> above.
+
+=item C<MCLU_PATH>
+
+The path to the directory that contains template files.  See
+L</TEMPLATE FILES> above.
+
+=back
+
+=head1 FILES
+
+
+
+
+=head1 SEE ALSO
+
+L<virt-builder(1)>,
+L<http://www.redhat.com/mailman/listinfo/virt-tools-list>
+
+=head1 AUTHORS
+
+Richard W.M. Jones <rjones @ redhat . com>
+
+=head1 COPYRIGHT
+
+(C) Copyright 2014-2015 Red Hat Inc.
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.