lxc-start-ephemeral.sgml.in revision 57da8c32f85c0255efa61ee32e260068afdaa565
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen(C) Copyright Canonical Ltd. 2013
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo SirainenStéphane Graber <stgraber@ubuntu.com>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo SirainenThis library is free software; you can redistribute it and/or
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainenmodify it under the terms of the GNU Lesser General Public
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo SirainenLicense as published by the Free Software Foundation; either
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainenversion 2.1 of the License, or (at your option) any later version.
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo SirainenThis library is distributed in the hope that it will be useful,
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainenbut WITHOUT ANY WARRANTY; without even the implied warranty of
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo SirainenMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo SirainenLesser General Public License for more details.
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo SirainenYou should have received a copy of the GNU Lesser General Public
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo SirainenLicense along with this library; if not, write to the Free Software
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo SirainenFoundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen<!DOCTYPE refentry PUBLIC @docdtd@ [
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen <refentrytitle>lxc-start-ephemeral</refentrytitle>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen <manvolnum>1</manvolnum>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen <refname>lxc-start-ephemeral</refname>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen start an ephemeral copy of an existing container
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen </refpurpose>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen </refnamediv>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen <refsynopsisdiv>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen <cmdsynopsis>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen <command>lxc-start-ephemeral</command>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen <arg choice="opt">-o</arg>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen <arg choice="opt">-n</arg>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen <arg choice="opt">-d</arg>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen <arg choice="opt">--bdir</arg>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen <arg choice="opt">--user</arg>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen <arg choice="opt">--key</arg>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen <arg choice="opt">--union-type</arg>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen <arg choice="opt">--keep-data</arg>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen <arg choice="opt">COMMAND</arg>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen </cmdsynopsis>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen </refsynopsisdiv>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen <title>Description</title>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen <command>lxc-start-ephemeral</command> start an ephemeral copy of an
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen existing container.
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen <title>Options</title>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen <variablelist>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen <varlistentry>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen <option>-o</option>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen Original container name
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen </varlistentry>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen <varlistentry>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen <option><optional>-n</optional></option>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen Name of the ephemeral container (defaults to a random suffix).
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen </varlistentry>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen <varlistentry>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen <option><optional>-d</optional></option>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen Start the container in background and print the name and IP.
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen This option can't be used if a command is passed.
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen </varlistentry>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen <varlistentry>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen <option><optional>--bdir</optional></option>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen Directory to bind mount into container.
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen Can be passed multiple times.
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen </varlistentry>
4a0641e1ff10f0b0299fd36baf38057c54268e48Timo Sirainen <varlistentry>
4a0641e1ff10f0b0299fd36baf38057c54268e48Timo Sirainen <option><optional>--user</optional></option>
4a0641e1ff10f0b0299fd36baf38057c54268e48Timo Sirainen The user to connect to the container as.
57593ca3c443884bac880b8deff7c0655ddd9a30Timo Sirainen Used when passing a command to lxc-start-ephemeral.
4a0641e1ff10f0b0299fd36baf38057c54268e48Timo Sirainen </varlistentry>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen <varlistentry>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen <option><optional>--key</optional></option>
4a0641e1ff10f0b0299fd36baf38057c54268e48Timo Sirainen Copy the provided SSH public key into the container.
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen </varlistentry>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen <varlistentry>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen <option><optional>--union-type</optional></option>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen Force a specific union file system.
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen Can be one of: overlayfs aufs
66c3f635f2f33905af527d49b27f95322aa7dfa7Timo Sirainen </varlistentry>
66c3f635f2f33905af527d49b27f95322aa7dfa7Timo Sirainen <varlistentry>
66c3f635f2f33905af527d49b27f95322aa7dfa7Timo Sirainen <option><optional>--keep-data</optional></option>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen Use a persistent backend instead of tmpfs.
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen With this option, you can lxc-stop and lxc-start the no longer so
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen ephemeral container (it's still an overlay, but a persistent one).
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen </varlistentry>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen <varlistentry>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen <option><optional>COMMAND</optional></option>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen Immediately run the provided command in the container.
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen This currently uses ssh (not attach) and is incompatible
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen with daemon mode.
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen </varlistentry>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen </variablelist>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen <title>See Also</title>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen <citerefentry>
7c849dbc7be089175c1a83a84ee7249ed695810dTimo Sirainen <refentrytitle>lxc-start</refentrytitle>
7c849dbc7be089175c1a83a84ee7249ed695810dTimo Sirainen <manvolnum>1</manvolnum>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen </citerefentry>,
4a0641e1ff10f0b0299fd36baf38057c54268e48Timo Sirainen <title>Examples</title>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen <variablelist>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen <varlistentry>
9137c55411aa39d41c1e705ddc34d5bd26c65021Timo Sirainen <term>lxc-start-ephemeral -o p1</term>
3b8d05391336c0e4d24c8ddcc962f350409ffbd3Timo Sirainen Simply start an ephemeral container and attach to the console.
3b8d05391336c0e4d24c8ddcc962f350409ffbd3Timo Sirainen This container will be based on existing container "p1".
3b8d05391336c0e4d24c8ddcc962f350409ffbd3Timo Sirainen </varlistentry>