doc/ja/lxc-copy.sgml.in

   1 <!--
   2
   3 lxc: linux Container library
   4
   5 (C) Copyright Canonical Inc. 2007, 2008
   6
   7 Authors:
   8 Christian Brauner <christian.brauner at mailbox.org>
   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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  23
  24 Translated into Japanese
  25 by KATOH Yasufumi <karma at jazz.email.ne.jp>
  26
  27 -->
  28
  29 <!DOCTYPE refentry PUBLIC @docdtd@ [
  30
  31 <!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
  32 <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
  33 ]>
  34
  35 <refentry>
  36
  37   <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
  38
  39   <refmeta>
  40     <refentrytitle>lxc-copy</refentrytitle>
  41     <manvolnum>1</manvolnum>
  42   </refmeta>
  43
  44   <refnamediv>
  45     <refname>lxc-copy</refname>
  46
  47     <refpurpose>
  48       <!--
  49       copy an existing container.
  50       -->
  51       既存のコンテナのコピー
  52     </refpurpose>
  53   </refnamediv>
  54
  55   <refsynopsisdiv>
  56     <cmdsynopsis>
  57       <command>lxc-copy</command>
  58       <arg choice="req">-n, --name <replaceable>name</replaceable></arg>
  59       <arg choice="opt">-P, --lxcpath <replaceable>path</replaceable></arg>
  60       <arg choice="req">-N, --newname <replaceable>newname</replaceable></arg>
  61       <arg choice="opt">-p, --newpath <replaceable>newpath</replaceable></arg>
  62       <arg choice="opt">-B, --backingstorage <replaceable>backingstorage</replaceable></arg>
  63       <arg choice="opt">-s, --snapshot</arg>
  64       <arg choice="opt">-a, --allowrunning</arg>
  65       <arg choice="opt">-K, --keepname</arg>
  66       <arg choice="opt">-D, --keepdata</arg>
  67       <arg choice="opt">-M, --keepmac</arg>
  68       <arg choice="opt">-L, --fssize <replaceable>size [unit]</replaceable></arg>
  69       <arg choice="opt">-- hook arguments</arg>
  70     </cmdsynopsis>
  71     <cmdsynopsis>
  72       <command>lxc-copy</command>
  73       <arg choice="req">-n, --name <replaceable>name</replaceable></arg>
  74       <arg choice="opt">-P, --lxcpath <replaceable>path</replaceable></arg>
  75       <arg choice="opt">-N, --newname <replaceable>newname</replaceable></arg>
  76       <arg choice="opt">-p, --newpath <replaceable>newpath</replaceable></arg>
  77       <arg choice="req">-e, --ephemeral</arg>
  78       <arg choice="opt">-B, --backingstorage <replaceable>backingstorage</replaceable></arg>
  79       <arg choice="opt">-s, --snapshot</arg>
  80       <arg choice="opt">-K, --keepname</arg>
  81       <arg choice="opt">-D, --keepdata</arg>
  82       <arg choice="opt">-M, --keepmac</arg>
  83       <arg choice="opt">-L, --fssize <replaceable>size [unit]</replaceable></arg>
  84       <arg choice="opt">-- hook arguments</arg>
  85     </cmdsynopsis>
  86     <cmdsynopsis>
  87       <command>lxc-copy</command>
  88       <arg choice="req">-n, --name <replaceable>name</replaceable></arg>
  89       <arg choice="opt">-P, --lxcpath <replaceable>path</replaceable></arg>
  90       <arg choice="opt">-N, --newname <replaceable>newname</replaceable></arg>
  91       <arg choice="opt">-p, --newpath <replaceable>newpath</replaceable></arg>
  92       <arg choice="req">-e, --ephemeral</arg>
  93       <arg choice="opt">-B, --backingstorage <replaceable>backingstorage</replaceable></arg>
  94       <arg choice="opt">-s, --snapshot</arg>
  95       <arg choice="opt">-a, --allowrunning</arg>
  96       <arg choice="opt">-t, --tmpfs</arg>
  97       <arg choice="opt">-K, --keepname</arg>
  98       <arg choice="opt">-M, --keepmac</arg>
  99       <arg choice="opt">-- hook arguments</arg>
 100     </cmdsynopsis>
 101     <cmdsynopsis>
 102       <command>lxc-copy</command>
 103       <arg choice="req">-n, --name <replaceable>name</replaceable></arg>
 104       <arg choice="opt">-P, --lxcpath <replaceable>path</replaceable></arg>
 105       <arg choice="req">-N, --newname <replaceable>newname</replaceable></arg>
 106       <arg choice="opt">-p, --newpath <replaceable>newpath</replaceable></arg>
 107       <arg choice="req">-R, --rename</arg>
 108     </cmdsynopsis>
 109   </refsynopsisdiv>
 110
 111   <refsect1>
 112     <title><!-- Description -->説明</title>
 113
 114     <para>
 115       <!--
 116       <command>lxc-copy</command> creates and optionally starts (ephemeral or
 117       non-ephemeral) copies of existing containers. It replaces
 118       <command>lxc-clone</command> and <command>lxc-start-ephemeral</command>.
 119       -->
 120       <command>lxc-copy</command> は、すでに存在するコンテナのコピーを作成します。オプションを指定することで、作成後にそのコピーを起動できます (コピーは一時的なコピーまたは永続的なコピーのどちらも可能です)。
 121       このコマンドは <command>lxc-clone</command> と <command>lxc-start-ephemeral</command> の置き換えのコマンドです。
 122     </para>
 123     <para>
 124       <!--
 125       <command>lxc-copy</command> creates copies of existing containers. Copies
 126       can be complete clones of the original container. In this case the whole
 127       root filesystem of the container is simply copied to the new container. Or
 128       they can be snapshots, i.e. small copy-on-write copies of the original
 129       container. In this case the specified backing storage for the copy must
 130       support snapshots. This currently includes btrfs, lvm (lvm devices
 131       do not support snapshots of snapshots.), overlay, and zfs.
 132       -->
 133       <command>lxc-copy</command> は、既存のコンテナのコピーを作成します。
 134       コピーは元のコンテナの完全なクローンにできます。この場合、単にコンテナのルートファイルシステムのすべてが、新しいコンテナにコピーされます。
 135       また、スナップショットを取得することも可能です。すなわち、元のコンテナの小さなコピーオンライトのコピーにするということです。この場合、コピーで指定するバッキングストレージがスナップショットをサポートしている必要があります。
 136       スナップショットをサポートしているバッキングストレージは、現時点では btrfs、lvm (lvm デバイスはスナップショットのスナップショットはサポートしていません)、overlay、zfs です。
 137     </para>
 138
 139     <para>
 140       <!--
 141     The copy's backing storage will be of the same type as the original
 142     container. overlay snapshots of directory backed containers are
 143     exempted from this rule.
 144     -->
 145       コピー先のバッキングストレージは、元のコンテナと同じタイプになるでしょう。ただし、ディレクトリバックエンドのコンテナのスナップショットは overlay で取得できますので例外です。
 146     </para>
 147
 148     <para>
 149       <!--
 150     When the <replaceable>-e</replaceable> flag is specified an ephemeral
 151     snapshot of the original container is created and started. Ephemeral
 152     containers will have <command>lxc.ephemeral = 1</command> set in their
 153     config file and will be destroyed on shutdown. When
 154     <replaceable>-e</replaceable> is used in combination with
 155     <replaceable>-D</replaceable> a non-ephemeral snapshot of the original
 156     container is created and started.
 157     Ephemeral containers can also be placed on a tmpfs with <replaceable>-t</replaceable>
 158     flag. NOTE: If an ephemeral container that is placed on a tmpfs is rebooted
 159     all changes made to it will currently be lost!
 160     -->
 161       <replaceable>-e</replaceable> オプションを指定した場合は、元のコンテナの一時的なスナップショットを作成し、起動します。一時的なコンテナの場合、設定ファイルに <command>lxc.ephemeral = 1</command> がセットされ、シャットダウン後に削除されます。
 162       <replaceable>-e</replaceable> と <replaceable>-D</replaceable> を同時に指定すると、元のコンテナの一時的ではないスナップショットを作成し、起動します。
 163       <replaceable>-t</replaceable> オプションを指定して、一時的なコンテナを tmpfs 上に置くことができます。
 164       注意: tmpfs 上に置いた一時的なコンテナをリブートすると、コンテナに対して行ったすべての変更は失われます!
 165     </para>
 166
 167     <para>
 168       <!--
 169     When <replaceable>-e</replaceable> is specified and no newname is given via
 170     <replaceable>-N</replaceable> a random name for the snapshot will be chosen.
 171     -->
 172       <replaceable>-e</replaceable> を指定した場合で、<replaceable>-N</replaceable> でコンテナの名前を指定しない場合は、スナップショットの名前はランダムで命名されます。
 173     </para>
 174
 175     <para>
 176       <!--
 177     Containers created and started with <replaceable>-e</replaceable> can have
 178     custom mounts. These are specified with the <replaceable>-m</replaceable>
 179     flag. Currently three types of mounts are supported:
 180     <replaceable>bind</replaceable>, and
 181     <replaceable>overlay</replaceable>. Mount types are specified as suboptions
 182     to the <replaceable>-m</replaceable> flag and can be specified multiple
 183     times separated by commas. <replaceable>overlay</replaceable> mounts are
 184     currently specified in the format <replaceable>-m
 185     overlay=/src:/dest</replaceable>.  When no destination
 186     <replaceable>dest</replaceable> is specified
 187     <replaceable>dest</replaceable> will be identical to
 188     <replaceable>src</replaceable>. Read-only <replaceable>bind</replaceable>
 189     mounts are specified <replaceable>-m bind=/src:/dest:ro</replaceable> and
 190     read-write <replaceable>bind</replaceable> mounts <replaceable>-m
 191     bind=/src:/dest:rw</replaceable>. Read-write <replaceable>bind</replaceable>
 192     mounts are the default and <replaceable>rw</replaceable> can be missing when
 193     a read-write mount is wanted. When <replaceable>dest</replaceable> is
 194     missing <replaceable>dest</replaceable> will be identical to
 195     <replaceable>src</replaceable>. An example for multiple mounts would be
 196     <replaceable>-m
 197     bind=/src1:/dest1:ro,bind=/src2:ro,overlay=/src3:/dest3</replaceable>.
 198     -->
 199       <replaceable>-e</replaceable> で作成し、起動したコンテナは、コンテナ独自のマウントを行えます。現時点では <replaceable>bind</replaceable>、<replaceable>overlay</replaceable> という 2 つのタイプのマウントがサポートされています。
 200       マウントタイプは <replaceable>-m</replaceable> オプションのサブオプションとして指定します。この指定はカンマ区切りで複数回指定できます。
 201       <replaceable>overlay</replaceable> マウントの場合は、現時点では <replaceable>-m overlay=/src:/dest</replaceable> のように指定します。マウント先の <replaceable>dest</replaceable> を指定しない場合は、<replaceable>dest</replaceable> は <replaceable>src</replaceable> と同じになります。
 202       読み込み専用の <replaceable>bind</replaceable> マウントは <replaceable>-m bind=/src:/dest:ro</replaceable> のように指定します。読み書き可能な <replaceable>bind</replaceable> マウントは <replaceable>-m bind=/src:/dest:rw</replaceable> のように指定します。<replaceable>bind</replaceable> マウントのデフォルトは読み書き可能ですので、読み書き可能なマウントを行う場合は省略できます。マウント先の <replaceable>dest</replaceable> を指定しない場合は、<replaceable>dest</replaceable> は <replaceable>src</replaceable> と同じになります。
 203       複数のマウントを行う場合の例を示すと、<replaceable>-m bind=/src1:/dest1:ro,bind=/src2:ro,overlay=/src3:/dest3</replaceable> のようになります。
 204     </para>
 205
 206     <para>
 207       <!--
 208     The mounts, their options, and formats supported via the
 209     <replaceable>-m</replaceable> flag are subject to change.
 210     -->
 211       <replaceable>-m</replaceable> オプションで指定するマウント、オプション、指定フォーマットは変更される可能性があります。
 212     </para>
 213   </refsect1>
 214
 215   <refsect1>
 216
 217     <title><!-- Options -->オプション</title>
 218
 219     <variablelist>
 220
 221           <varlistentry>
 222             <term> <option>-N,--newname <replaceable>newname</replaceable></option> </term>
 223            <listitem>
 224             <para><!-- The name for the copy. -->コピー先のコンテナの名前。</para>
 225            </listitem>
 226           </varlistentry>
 227
 228           <varlistentry>
 229             <term> <option>-p,--newpath <replaceable>newpath</replaceable></option> </term>
 230            <listitem>
 231             <para><!-- The path for the copy. -->コピー先のパス。</para>
 232            </listitem>
 233           </varlistentry>
 234
 235           <varlistentry>
 236             <term> <option>-R,--rename </option> </term>
 237            <listitem>
 238             <para><!-- Rename the original container. -->元のコンテナをリネームします。</para>
 239            </listitem>
 240           </varlistentry>
 241
 242           <varlistentry>
 243             <term> <option>-s,--snapshot </option> </term>
 244            <listitem>
 245             <para><!-- Create a snapshot of the original container. The backing
 246             storage for the copy must support snapshots. This currently includes
 247             btrfs, lvm, overlay, and zfs. -->
 248               元のコンテナのスナップショットを作成します。コピー先のバッキングストレージがスナップショットをサポートしている必要があります。現時点では btrfs、lvm、overlay、zfs が対象となります。
 249             </para>
 250            </listitem>
 251           </varlistentry>
 252
 253           <varlistentry>
 254             <term> <option>-a,--allowrunning </option> </term>
 255            <listitem>
 256             <para><!-- Allow the creation of a Snapshot of an already running container.
 257             This may cause data corruption or data loss depending on the used
 258             filesystem and applications. Use with care. -->
 259               実行中のコンテナのスナップショットを作成します。
 260               これは、使用しているファイルシステムやアプリケーションによっては、データの破損や欠損を引き起こす可能性があります。
 261               注意して使用してください。
 262             </para>
 263            </listitem>
 264           </varlistentry>
 265
 266           <varlistentry>
 267             <term> <option>-F,--foreground</option> </term>
 268            <listitem>
 269             <para><!-- Run the snapshot in the foreground. The snapshots console will
 270             be attached to the current tty. (This option can only be specified
 271             in conjunction with <replaceable>-e</replaceable>.) -->
 272               スナップショットしたコンテナをフォアグラウンドで起動します。スナップショットしたコンテナのコンソールは現在の tty にアタッチされます。(このオプションは <replaceable>-e</replaceable> と同時の場合のみ指定できます。)
 273             </para>
 274            </listitem>
 275           </varlistentry>
 276
 277           <varlistentry>
 278             <term> <option>-d, --daemon</option> </term>
 279            <listitem>
 280             <para><!-- Run the snapshot as a daemon (This is the default mode for
 281             ephemeral containers.). As the container has no more tty, if an
 282             error occurs nothing will be displayed, the log file can
 283             be used to check the error. (This option can only be specified in
 284             conjunction with <replaceable>-e</replaceable>.) -->
 285               スナップショットしたコンテナをデーモンで起動します (一時的なコンテナではこのモードがデフォルトです)。
 286               コンテナは tty を持ちませんので、エラーが発生しても何も表示されません。エラーをチェックするにはログファイルを使います。(このオプションは <replaceable>-e</replaceable> と同時の場合のみ指定できます。)
 287             </para>
 288            </listitem>
 289           </varlistentry>
 290
 291           <varlistentry>
 292             <term> <option>-m, --mount <replaceable>mounttype</replaceable></option> </term>
 293            <listitem>
 294             <para><!--  Specify a mount for a snapshot  The
 295             <replaceable>opts</replaceable> argument for the mount type can by
 296             of type {bind, overlay}. For example <option>-m
 297             bind=/src:/dest:ro,overlay=/src:/dest</option> (This option can
 298             currently only be specified in conjunction with
 299             <replaceable>-e</replaceable>.). --></para>
 300               スナップショットするコンテナで行うマウントを指定します。マウントタイプは {bind, overlay} のどれかで指定します。例えば <option>-m bind=/src:/dest:ro,overlay=/src:/dest</option> のようになります。(このオプションは <replaceable>-e</replaceable> と同時の場合のみ指定できます。)
 301            </listitem>
 302           </varlistentry>
 303
 304           <varlistentry>
 305             <term> <option>-t, --tmpfs </option></term>
 306            <listitem>
 307             <para><!-- When this option is specified the ephemeral container will be
 308             placed on a tmpfs. NOTE: Rebooting an ephemeral container that is
 309             located on a tmpfs will currently cause all changes made to it to be
 310             lost. This flag will only work for ephemeral containers created with
 311             the <replaceable>-e</replaceable> flag. The original container, from
 312             which the ephemeral snapshot is created, must be stored as a simple
 313             directory. -->
 314               このオプションを指定すると、一時的なコンテナを tmpfs 上に置きます。
 315               注意: tmpfs 上に置かれた一時的なコンテナをリブートすると、コンテナに対して行ったすべての変更が失われます。
 316               このフラグは <replaceable>-e</replaceable> オプションを指定して作成した一時的なコンテナに対してのみ有効です。一時的なスナップショットを作成する元のコンテナは、ディレクトリバックエンド上に存在しなければなりません。
 317             </para> </listitem>
 318           </varlistentry>
 319
 320           <varlistentry>
 321             <term> <option>-B, --backingstorage <replaceable>backingstorage</replaceable></option></term>
 322            <listitem>
 323             <para><!-- Specify the backing storage type to be used for the copy
 324             where 'backingstorage' is of type 'btrfs', 'dir', 'lvm', 'loop',
 325             'overlay', or 'zfs'. -->
 326               コピー先コンテナのバッキングストレージのタイプを指定します。ここで 'backingstorage' は 'btrfs'、'dir'、'lvm'、'loop'、'overlay'、'zfs' のどれかです。
 327             </para>
 328            </listitem>
 329           </varlistentry>
 330
 331           <varlistentry>
 332             <term> <option>-L, --fssize <replaceable>size [unit]</replaceable></option></term>
 333            <listitem>
 334             <para><!-- Specify the size for an 'lvm' filesystem. -->'lvm' ファイルシステムのサイズを指定します。</para>
 335            </listitem>
 336           </varlistentry>
 337
 338           <varlistentry>
 339             <term> <option>-K, --keepname </option></term>
 340            <listitem>
 341             <para><!-- When this option is specified the hostname of the original
 342               container will be kept for the copy. -->
 343               このオプションを指定すると、元のコンテナのホスト名をコピー先でもそのまま使います。
 344             </para>
 345            </listitem>
 346           </varlistentry>
 347
 348           <varlistentry>
 349             <term> <option>-D, --keepdata </option></term>
 350            <listitem>
 351             <para><!-- When this option is specified with
 352             <replaceable>-e</replaceable> a non-ephemeral container is created
 353             and started. -->
 354               <replaceable>-e</replaceable> オプションと同時にこのオプションを使うと、一時的でないコンテナを作成し、起動します。
 355             </para>
 356            </listitem>
 357           </varlistentry>
 358
 359           <varlistentry>
 360             <term> <option>-M, --keepmac </option></term>
 361            <listitem>
 362             <para><!-- When this option is specified the MAC address of the original
 363               container will be kept for the copy. -->
 364               このオプションを指定すると、元のコンテナの MAC アドレスをコピー先でもそのまま使います。
 365             </para>
 366            </listitem>
 367           </varlistentry>
 368
 369     </variablelist>
 370
 371   </refsect1>
 372
 373   <refsect1>
 374     <title><!-- Copy hook -->コピー時のフック</title>
 375     <para>
 376       <!--
 377       If the container being copied has one or more
 378       <filename>lxc.hook.clone</filename> specified, then the specified hooks
 379       will be called for the new container. The first 3 arguments passed to the
 380       clone hook will be the container name, a section ('lxc'), and the hook
 381       type ('clone'). Extra arguments passed to <command>lxc-copy</command> will
 382       be passed to the hook program starting at argument 4. The
 383       <filename>LXC_ROOTFS_MOUNT</filename> environment variable gives
 384       the path under which the container's root filesystem is mounted. The
 385       configuration file pathname is stored in
 386       <filename>LXC_CONFIG_FILE</filename>, the new container name in
 387       <filename>LXC_NAME</filename>, the old container name in
 388       <filename>LXC_SRC_NAME</filename>, and the path or device on which the
 389       rootfs is located is in <filename>LXC_ROOTFS_PATH</filename>.
 390       -->
 391       コピーされるコンテナに 1 つ以上の <filename>lxc.hook.clone</filename> の指定が存在する場合、指定されたフックは新しいコンテナに対して呼ばれます。
 392       クローンフックに渡される最初の 3 つの引数は、コンテナ名、セクション ('lxc')、フックタイプ ('clone') となります。
 393       <command>lxc-copy</command> に渡される追加の引数は、フックプログラムに渡される引数の 4 番目以降となります。
 394       <filename>LXC_ROOTFS_MOUNT</filename> 環境変数には、コンテナの root ファイルシステムがマウントされるパスが与えられます。
 395       設定ファイルのパス名は <filename>LXC_CONFIG_FILE</filename> に、新しいコンテナ名は <filename>LXC_NAME</filename>、古いコンテナ名は <filename>LXC_SRC_NAME</filename> に、rootfs のあるパスまたはデバイスは <filename>LXC_ROOTFS_PATH</filename> に保存されます。
 396     </para>
 397   </refsect1>
 398
 399   &commonoptions;
 400
 401   &seealso;
 402
 403   <refsect1>
 404     <title>Author</title>
 405     <para>Christian Brauner <email>christian.brauner@mailbox.org</email></para>
 406   </refsect1>
 407
 408 </refentry>
 409
 410 <!-- Keep this comment at the end of the file
 411 Local variables:
 412 mode: sgml
 413 sgml-omittag:t
 414 sgml-shorttag:t
 415 sgml-minimize-attributes:nil
 416 sgml-always-quote-attributes:t
 417 sgml-indent-step:2
 418 sgml-indent-data:t
 419 sgml-parent-document:nil
 420 sgml-default-dtd-file:nil
 421 sgml-exposed-tags:nil
 422 sgml-local-catalogs:nil
 423 sgml-local-ecat-files:nil
 424 End:
 425 -->