doc/lxc-create.sgml.in

   1 <!--
   2
   3 lxc: linux Container library
   4
   5 (C) Copyright IBM Corp. 2007, 2008
   6
   7 Authors:
   8 Daniel Lezcano <dlezcano at fr.ibm.com>
   9
  10 This library is free software; you can redistribute it and/or
  11 modify it under the terms of the GNU Lesser General Public
  12 License as published by the Free Software Foundation; either
  13 version 2.1 of the License, or (at your option) any later version.
  14
  15 This library is distributed in the hope that it will be useful,
  16 but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18 Lesser General Public License for more details.
  19
  20 You should have received a copy of the GNU Lesser General Public
  21 License along with this library; if not, write to the Free Software
  22 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  23
  24 -->
  25
  26 <!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
  27
  28 <!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
  29 <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
  30 ]>
  31
  32 <refentry>
  33
  34   <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
  35
  36   <refmeta>
  37     <refentrytitle>lxc-create</refentrytitle>
  38     <manvolnum>1</manvolnum>
  39   </refmeta>
  40
  41   <refnamediv>
  42     <refname>lxc-create</refname>
  43
  44     <refpurpose>
  45       creates a container
  46     </refpurpose>
  47   </refnamediv>
  48
  49   <refsynopsisdiv>
  50     <cmdsynopsis>
  51       <command>lxc-create</command>
  52       <arg choice="req">-n <replaceable>name</replaceable></arg>
  53       <arg choice="opt">-f <replaceable>config_file</replaceable></arg>
  54       <arg choice="opt">-t <replaceable>template</replaceable></arg>
  55       <arg choice="opt">-B <replaceable>backingstore</replaceable></arg>
  56       <arg choice="opt">-- <replaceable>template-options</replaceable></arg>
  57     </cmdsynopsis>
  58   </refsynopsisdiv>
  59
  60   <refsect1>
  61     <title>Description</title>
  62
  63     <para>
  64       <command>lxc-create</command> creates a system object where is
  65       stored the configuration informations and where can be stored
  66       user information. The identifier <replaceable>name</replaceable>
  67       is used to specify the container to be used with the different
  68       lxc commands.
  69     </para>
  70     <para>
  71       The object is a directory created in <filename>@LXCPATH@</filename>
  72       and identified by its name.
  73     </para>
  74
  75     <para>
  76       The object is the definition of the different resources an
  77       application can use or can see. The more the configuration file
  78       contains informations, the more the container is isolated and
  79       the more the application is jailed.
  80     </para>
  81
  82     <para>
  83       If the configuration file <replaceable>config_file</replaceable>
  84       is not specified, the container will be created with the default
  85       isolation: processes, sysv ipc and mount points.
  86     </para>
  87   </refsect1>
  88
  89   <refsect1>
  90     <title>Options</title>
  91     <variablelist>
  92
  93       <varlistentry>
  94         <term>
  95           <option>-f <replaceable>config_file</replaceable></option>
  96         </term>
  97         <listitem>
  98           <para>
  99             Specify the configuration file to configure the virtualization
 100             and isolation functionalities for the container.
 101           </para>
 102         </listitem>
 103       </varlistentry>
 104
 105       <varlistentry>
 106         <term>
 107           <option>-t <replaceable>template</replaceable></option>
 108         </term>
 109         <listitem>
 110           <para>
 111             'template' is the short name of an existing 'lxc-template'
 112             script that is called by lxc-create,
 113             eg. busybox, debian, fedora, ubuntu or sshd.
 114             Refer to the examples in <filename>@LXCTEMPLATEDIR@</filename>
 115             for details of the expected script structure.
 116           </para>
 117         </listitem>
 118       </varlistentry>
 119
 120       <varlistentry>
 121         <term>
 122           <option>-B <replaceable>backingstore</replaceable></option>
 123         </term>
 124         <listitem>
 125           <para>
 126             'backingstore' is one of 'none', 'lvm', or 'btrfs'.  The
 127             default is 'none', meaning that the container root filesystem
 128             will be a directory under <filename>@LXCPATH@/container/rootfs</filename>.
 129             The option 'btrfs' need not be specified as it will be used
 130             automatically if the <filename>@LXCPATH@</filename> filesystem is found to
 131             be btrfs.  If backingstore is 'lvm', then an lvm block device will be
 132             used and the following further options are available:
 133             <replaceable>--lvname lvname1</replaceable> will create an LV
 134             named <filename>lvname1</filename> rather than the default, which
 135             is the container name.  <replaceable>--vgname vgname1</replaceable>
 136             will create the LV in volume group <filename>vgname1</filename>
 137             rather than the default, <filename>lxc</filename>.
 138             <replaceable>--fstype FSTYPE</replaceable> will create an FSTYPE
 139             filesystem on the LV, rather than the default, which is ext4.
 140             <replaceable>--fssize SIZE</replaceable> will create a LV (and
 141             filesystem) of size SIZE rather than the default, which is 1G.
 142           </para>
 143         </listitem>
 144
 145       <varlistentry>
 146         <term>
 147           <option>-- <replaceable>template-options</replaceable></option>
 148         </term>
 149         <listitem>
 150           <para>
 151             This will pass <replaceable>template-options</replaceable> to the
 152             template as arguments.  To see the list of options supported by
 153             the template, you can run
 154             <command>lxc-create -t TEMPLATE -h</command>.
 155           </para>
 156         </listitem>
 157       </varlistentry>
 158
 159     </variablelist>
 160
 161   </refsect1>
 162
 163   <refsect1>
 164     <title>Diagnostic</title>
 165
 166     <variablelist>
 167
 168       <varlistentry>
 169         <term>The container already exists</term>
 170         <listitem>
 171           <para>
 172             As the message mention it, you try to create a container
 173             but there is a container with the same name. You can use
 174             the <command>lxc-ls -l</command> command to list the
 175             available containers on the system.
 176           </para>
 177         </listitem>
 178       </varlistentry>
 179
 180     </variablelist>
 181
 182   </refsect1>
 183
 184   &seealso;
 185
 186   <refsect1>
 187     <title>Author</title>
 188     <para>Daniel Lezcano <email>daniel.lezcano@free.fr</email></para>
 189   </refsect1>
 190
 191 </refentry>
 192
 193 <!-- Keep this comment at the end of the file
 194 Local variables:
 195 mode: sgml
 196 sgml-omittag:t
 197 sgml-shorttag:t
 198 sgml-minimize-attributes:nil
 199 sgml-always-quote-attributes:t
 200 sgml-indent-step:2
 201 sgml-indent-data:t
 202 sgml-parent-document:nil
 203 sgml-default-dtd-file:nil
 204 sgml-exposed-tags:nil
 205 sgml-local-catalogs:nil
 206 sgml-local-ecat-files:nil
 207 End:
 208 -->