mirror_lxc/doc/lxc-snapshot.sgml.in
Serge Hallyn 18aa217bb1 snapshots: move snapshot directory
Originally we kept snapshots under /var/lib/lxcsnaps.  If a
separate btrfs is mounted at /var/lib/lxc, then we can't
make btrfs snapshots under /var/lib/lxcsnaps.

This patch moves the default directory to /var/lib/lxc/c/snaps.
If /var/lib/lxcsnaps already exists, then we continue to use that.

add c->destroy_with_snapshots() and c->snapshot_destroy_all()
API methods.  c->snashot_destroy_all() can be triggered from
lxc-snapshot using '-d ALL'.  There is no command to call
c->destroy_with_snapshots(c) as of yet.

lxclock: use ".$lxcname" for container lock files
that way we can use /run/lock/lxc/$lxcpath/$lxcname/snaps as a
directory when locking snapshots without having to worry about
/run/lock//lxc/$lxcpath/$lxcname being a file.

destroy: split off a container_destroy
container_destroy() doesn't check for snapshots, so snapshot_rename can
use it.  api_destroy() now does check for snapshots (previously it only
checked for fs - i.e. overlayfs/aufs - snapshots).

Add destroy to the manpage, as it was previously undocumented.

Update snapshot testcase accordingly.

[ rebased in the face of commits 840f05df and 7e36f87e. ]

Signed-off-by: Serge Hallyn <serge.hallyn@ubuntu.com>
Acked-by: S.Çağlar Onur <caglar@10ur.org>
Acked-by: Stéphane Graber <stgraber@ubuntu.com>
2014-06-18 16:28:39 -05:00

166 lines
5.0 KiB
Plaintext

<!--
lxc: linux Container library
(C) Copyright Canonical Inc. 2007, 2008
Authors:
Serge Hallyn <serge.hallyn at ubuntu.com>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library 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
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
-->
<!DOCTYPE refentry PUBLIC @docdtd@ [
<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
]>
<refentry>
<docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
<refmeta>
<refentrytitle>lxc-snapshot</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>lxc-snapshot</refname>
<refpurpose>
Snapshot an existing container.
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>lxc-snapshot</command>
<arg choice="req">-n, --name <replaceable>name</replaceable></arg>
<arg choice="opt">-c, --comment <replaceable>file</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>lxc-snapshot</command>
<arg choice="req">-n, --name <replaceable>name</replaceable></arg>
<arg choice="req">-d, -destroy <replaceable>snapshot-name</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>lxc-snapshot</command>
<arg choice="req">-n, --name <replaceable>name</replaceable></arg>
<arg choice="req">-L, --list </arg>
<arg choice="opt">-C, --showcomments </arg>
</cmdsynopsis>
<cmdsynopsis>
<command>lxc-snapshot</command>
<arg choice="req">-n, --name <replaceable>name</replaceable></arg>
<arg choice="req">-r, -restore <replaceable>snapshot-name</replaceable></arg>
<arg choice="opt"> <replaceable> newname</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
<command>lxc-snapshot</command> creates, lists, and restores
container snapshots.
</para>
<para>
Snapshots are stored as snapshotted containers under a private configuration path. For instance, if the container's configuration path is <filename>/var/lib/lxc</filename> and the container is <filename>c1</filename>, then the first snapshot will be stored as container <filename>snap0</filename> under configuration path <filename>/var/lib/lxcsnaps/c1</filename>.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<variablelist>
<varlistentry>
<term> <option>-c,--comment <replaceable>comment_file</replaceable></option> </term>
<listitem>
<para> Associate the comment in <replaceable>comment_file</replaceable> with the newly created snapshot.</para>
</listitem>
</varlistentry>
<varlistentry>
<term> <option>-d,--destroy snapshot-name</option> </term>
<listitem>
<para> Destroy the named snapshot. If the named snapshot is ALL, then all snapshots
will be destroyed.</para>
</listitem>
</varlistentry>
<varlistentry>
<term> <option>-L,--list </option> </term>
<listitem>
<para> List existing snapshots. </para>
</listitem>
</varlistentry>
<varlistentry>
<term> <option>-C,--showcomments </option> </term>
<listitem>
<para> Show snapshot comments in the snapshots listings. </para>
</listitem>
</varlistentry>
<varlistentry>
<term> <option>-r,--restore snapshot-name</option> </term>
<listitem>
<para> Restore the named snapshot, meaning a full new container is created which is a copy of the snapshot.</para>
</listitem>
</varlistentry>
<varlistentry>
<term> <option>newname</option> </term>
<listitem>
<para> When restoring a snapshot, the last optional argument is the name to use for the restored container. If no name is given, then the original container will be destroyed and the restored container will take its place. Note that deleting the original snapshot is not possible in the case of aufs, overlayfs or zfs backed snapshots.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
&commonoptions;
&seealso;
<refsect1>
<title>Author</title>
<para>Serge Hallyn <email>serge.hallyn@ubuntu.com </email></para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->