doc: Add the rename option to lxc-clone(1)

[mirror_lxc.git] / doc / ja / lxc-clone.sgml.in

<!--

lxc: linux Container library

(C) Copyright IBM Corp. 2007, 2008

Authors:
Daniel Lezcano <daniel.lezcano at free.fr>
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

Translated into Japanese
by KATOH Yasufumi <karma at jazz.email.ne.jp>

-->

<!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-clone</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>lxc-clone</refname>

    <refpurpose>
      <!--
      clone a new container from an existing one.
      -->
      既存のコンテナからの新しいコンテナのクローン
    </refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>lxc-clone</command>
      <arg choice="opt">-s </arg>
      <arg choice="opt">-K </arg>
      <arg choice="opt">-M </arg>
      <arg choice="opt">-H </arg>
      <arg choice="opt">-B <replaceable>backingstore</replaceable></arg>
      <arg choice="opt">-L <replaceable>fssize</replaceable></arg>
      <arg choice="opt">-p <replaceable>lxcpath</replaceable></arg>
      <arg choice="opt">-P <replaceable>newlxcpath</replaceable></arg>
      <arg choice="opt">-R </arg>
      <arg choice="req">-o <replaceable>orig</replaceable></arg>
      <arg choice="req">-n <replaceable>new</replaceable></arg>
      <arg choice="opt">-- hook arguments</arg>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>lxc-clone</command>
      <arg choice="opt">-s </arg>
      <arg choice="opt">-K </arg>
      <arg choice="opt">-M </arg>
      <arg choice="opt">-H </arg>
      <arg choice="opt">-B <replaceable>backingstore</replaceable></arg>
      <arg choice="opt">-L <replaceable>fssize</replaceable></arg>
      <arg choice="opt">-p <replaceable>lxcpath</replaceable></arg>
      <arg choice="opt">-P <replaceable>newlxcpath</replaceable></arg>
      <arg choice="opt">-R </arg>
      <arg choice="req">orig</arg>
      <arg choice="req">new</arg>
      <arg choice="opt">-- hook arguments</arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title><!-- Description -->説明</title>

    <para>
      <!--
      <command>lxc-clone</command> Creates a new container as a clone of an existing
      container.  Two types of clones are supported: copy and snapshot.  A copy
      clone copies the root filessytem from the original container to the new.  A
      snapshot filesystem uses the backing store's snapshot functionality to create
      a very small copy-on-write snapshot of the original container.  Snapshot
      clones require the new container backing store to support snapshotting.  Currently
      this includes only aufs, btrfs, lvm, overlayfs and zfs.  LVM devices do not support
      snapshots of snapshots.
      -->
      <command>lxc-clone</command> は、新しいコンテナを既に存在するコンテナのクローンとして作製します。
      クローンは 2 つのタイプをサポートします: コピーとスナップショットです。
      コピータイプのクローンは元のコンテナから新しいコンテナへ root ファイルシステムをコピーします。
      スナップショットファイルシステムは、バッキングストアのスナップショット機能を使い、元のコンテナの非常に小さな copy-on-write でのスナップショットを作製します。
      スナップショットでのクローンは、新しいコンテナのバッキングストアとしてスナップショット機能のサポートが必要になります。
      現時点では、このようなバッキングストアとしては aufs, btrfs, lvm, overlayfs, zfs のみをサポートします。
      LVM デバイスはスナップショットのスナップショットはサポートしていません。
    </para>

    <para>
      <!--
      The backing store of the new container will be the same type as the
      original container, with one exception, overlay containers.
      aufs and overlayfs snapshots can be created of directory backed
      containers.  This can be requested by using (for overlayfs) the
      <replaceable>-B overlayfs</replaceable> arguments.
      -->
      新しいコンテナのバッキングストアは、オーバーレイタイプのコンテナを除いては元のコンテナのタイプと同じになります。
      ディレクトリバックエンドのコンテナのスナップショットを aufs もしくは overlayfs で作成することは可能です。
      例えば、overlayfs の場合は <replaceable>-B overlayfs</replaceable> という引数を使って指定することが可能です。
    </para>

    <para>
      <!--
      The names of the original and new container can be given (in that order)
      after all options, or can be specified with the
      <replaceable>-o</replaceable> and <replaceable>-n</replaceable> options,
      respectively.
      -->
      元のコンテナと新しいコンテナの名前は、全てのオプションの後に順番に与えることも、<replaceable>-o</replaceable> と <replaceable>-n</replaceable> オプションを使ってそれぞれ指定することも可能です。
    </para>

  </refsect1>

  <refsect1>

    <title><!-- Options -->オプション</title>

    <variablelist>

      <varlistentry>
	<term>
	  <option>-s, --snapshot</option>
	</term>
	<listitem>
	  <para>
            <!--
	    The new container's rootfs will be a snapshot of the original. This option can be specified when the backing store is LVM, btrfs or zfs, and must be specified when you want to snapshot using aufs or overlayfs.
              -->
	    新しいコンテナの rootfs はオリジナルのスナップショットとなります。
	    このオプションはバッキングストアが LVM か btrfs か zfs の時に使用できます。
	    また、スナップショットを aufs か overlayfs で取得したい場合は指定する必要があります。
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>
	  <option>-K, --keepname</option>
	</term>
	<listitem>
	  <para>
            <!--
	    Do not change the hostname of the container (in the root
	    filesystem).
            -->
            (root ファイルシステム内では) コンテナのホスト名を変更しません。
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>
	  <option>-M, --keepmac</option>
	</term>
	<listitem>
	  <para>
            <!--
	    Use the same MAC address as the original container, rather than
	    generating a new random one.
            -->
            新しい MAC アドレスをランダムに生成せずに、元のコンテナと同じ MAC アドレスを使用します。
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>
	  <option>-H, --copyhooks</option>
	</term>
	<listitem>
	  <para>
            <!--
	    Copy all mount hooks into the new container's directory, and
	    update any lxcpaths and container names as needed.
            -->
            全てのマウントフックを新しいコンテナのディレクトリにコピーします。
            そして、lxcpath とコンテナ名を必要に応じて更新します。
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>
	  <option>-L, --fssize <replaceable>fssize</replaceable></option>
	</term>
	<listitem>
	  <para>
            <!--
	    In the case of a block device backed container, a size for the new
	    block device.  By default, the new device will be made the
	    same size as the original.
            -->
            ブロックデバイスのバックエンドのコンテナの場合、新しいブロックデバイスのサイズ。
            デフォルトでは、新しいデバイスは元のデバイスと同じサイズとなります。
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>
	  <option>-p, --lxcpath <replaceable>lxcpath</replaceable></option>
	</term>
	<listitem>
	  <para>
            <!--
	    The lxcpath of the original container.  By default, the system
	    wide configured lxcpath will be used.
            -->
            オリジナルのコンテナの lxcpath。デフォルトでは、システム全体で設定された lxcpath が使われます。
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>
	  <option>-P, --newpath <replaceable>newlxcpath</replaceable></option>
	</term>
	<listitem>
	  <para>
            <!--
	    The lxcpath for the new container.  By default the same lxcpath
	    as the original will be used.  Note that with btrfs snapshots,
	    changing lxcpaths may not be possible, as subvolume snapshots
	    must be in the same btrfs filesystem.
            -->
            新しいコンテナの lxcpath。
            デフォルトでは、オリジナルの lxcpath と同じものが使われます。
            btrfs のスナップショットの場合は注意が必要で、lxcpath の変更はできない可能性があります。
            これは subvolume のスナップショットが、同じ btrfs ファイルシステム上に存在しなければならないからです。
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>
	  <option>-B, --backingstore <replaceable>backingstore</replaceable></option>
	</term>
	<listitem>
	  <para>
            <!--
	    Select a different backing store for the new container.  By
	    default the same as the original container's is used.  Note that
	    currently changing the backingstore is only supported for
	    aufs and overlayfs snapshots of directory backed containers.  Valid
	    backing stores include dir (directory), aufs, btrfs, lvm, zfs, loop
	    and overlayfs.
            -->
            新しいコンテナで元のコンテナと違うバッキングストアを使う場合のバッキングストアを選択します。
            デフォルトでは元のコンテナと同じものが使われます。
            現時点では、バッキングストアの変更は、ディレクトリバックエンドのコンテナに対する aufs と overlayfs のスナップショットに対してのみサポートされます。
            有効なバッキングストアは dir(directory), aufs, btrfs, lvm, zfs, loop, overlayfs です。
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>
	  <option>-R, --rename</option>
	</term>
	<listitem>
	  <para>
	    <!--
	    Rename an existing container.
	    <replaceable>orig</replaceable> is renamed <replaceable>new</replaceable>.
	    -->
	    コンテナの名前を変更します。<replaceable>orig</replaceable> を <replaceable>new</replaceable> という名前に変更します。
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>
	  <option>-o, --orig <replaceable>orig</replaceable></option>
	</term>
	<listitem>
	  <para>
            <!--
	    The name of the original container to clone.
            -->
            クローンしたい元のコンテナの名前。
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>
	  <option>-n, --new <replaceable>new</replaceable></option>
	</term>
	<listitem>
	  <para>
            <!--
	    The name of the new container to create.
            -->
            作製する新しいコンテナの名前。
	  </para>
	</listitem>
      </varlistentry>


    </variablelist>

  </refsect1>

  <refsect1>
    <title>Clone hook</title>
    <para>
      <!--
      If the container being cloned has one or more <filename>lxc.hook.clone</filename>
      specified, then the specified hooks will be called for the new container.  The
      first 3 arguments passed to the clone hook will be the container name, a section
      ('lxc'), and the hook type ('clone').  Extra arguments passed
      <command>lxc-clone</command> will be passed to the hook program starting at
      argument 4.  The <filename>LXC_ROOTFS_MOUNT</filename> environment variable gives
      the path under which the container's root filesystem is mounted.  The
      configuration file pathname is stored in <filename>LXC_CONFIG_FILE</filename>, the
      new container name in <filename>LXC_NAME</filename>, the old container name in
      <filename>LXC_SRC_NAME</filename>, and the path or device on which
      the rootfs is located is in <filename>LXC_ROOTFS_PATH</filename>.
      -->
      クローンされるコンテナに 1 つ以上の <filename>lxc.hook.clone</filename> の指定が存在する場合、指定されたフックは新しいコンテナに対して呼ばれます。
      クローンフックに渡される最初の 3 つの引数は、コンテナ名、セクション ('lxc')、フックタイプ ('clone') となります。
      <command>lxc-clone</command> に渡される追加の引数は、フックプログラムに渡される引数の 4 番目以降となります。
      <filename>LXC_ROOTFS_MOUNT</filename> 環境変数には、コンテナの root ファイルシステムがマウントされるパスが与えられます。
      設定ファイルのパス名は <filename>LXC_CONFIG_FILE</filename> に、新しいコンテナ名は <filename>LXC_NAME</filename>、古いコンテナ名は <filename>LXC_SRC_NAME</filename> に、rootfs のあるパスまたはデバイスは <filename>LXC_ROOTFS_PATH</filename> に保存されます。
    </para>
  </refsect1>

  &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:
-->