3 lxc: linux Container library
5 (C) Copyright IBM Corp. 2007, 2008
8 Daniel Lezcano <daniel.lezcano at free.fr>
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.
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.
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
24 Translated into Japanese
25 by KATOH Yasufumi <karma at jazz.email.ne.jp>
29 <!DOCTYPE refentry PUBLIC @docdtd@ [
31 <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
37 <date>@LXC_GENERATE_DATE@</date>
42 <refentrytitle>lxc</refentrytitle>
43 <manvolnum>7</manvolnum>
45 Version @PACKAGE_VERSION@
50 <refname>lxc</refname>
61 <title><!-- Overview -->概要</title>
64 The container technology is actively being pushed into the mainstream
65 Linux kernel. It provides resource management through control groups and
66 resource isolation via namespaces.
68 コンテナ技術は、メインストリームの Linux Kernel で活発に開発が進んでいる技術です。コンテナ技術は、cgroup によりリソースを管理する機能を提供し、名前空間によりリソースを隔離する機能を提供します。
73 <command>lxc</command>, aims to use these new functionalities to provide a
74 userspace container object which provides full resource isolation and
75 resource control for an applications or a full system.
77 <command>lxc</command> は、アプリケーションまたはシステムのために完全なリソースの隔離やコントロールを提供する、ユーザースペースのコンテナオブジェクトを提供するためのこれらの新しい機能を使う事を目指しています。
82 <command>lxc</command> is small enough to easily manage a container with
83 simple command lines and complete enough to be used for other purposes.
85 <command>lxc</command> は、シンプルなコマンドラインでコンテナを簡単に管理できるほど軽量で、他の用途に使うのにも十分に機能がそろっています。
90 <title><!-- Requirements -->動作条件</title>
93 The kernel version >= 3.10 shipped with the distros, will work with
94 <command>lxc</command>, this one will have less functionalities but enough
97 カーネルのバージョンが 3.10 以上のディストリビューションであれば、<command>lxc</command> が動作するでしょう。このバージョンは機能は少ないですが、それでも十分楽しめるでしょう。
102 <command>lxc</command> relies on a set of functionalities provided by the
103 kernel. The helper script <command>lxc-checkconfig</command> will give
104 you information about your kernel configuration, required, and missing
107 <command>lxc</command> はカーネルが提供する様々な機能に依存します。<command>lxc-checkconfig</command> がカーネルの設定や、必要な機能、足りない機能についての情報を提供してくれるでしょう。
112 <title><!-- Functional specification -->機能仕様</title>
115 A container is an object isolating some resources of the host, for the
116 application or system running in it.
118 コンテナは、ホストのリソースのいくつかを隔離して、内部でアプリケーションやシステムを実行します。
122 The application / system will be launched inside a container specified by
123 a configuration that is either initially created or passed as a parameter
126 アプリケーションやシステムは、あらかじめ作成した設定や、コマンドへのパラメータで与えた設定で、コンテナ内で実行されます。
131 How to run an application in a container
133 コンテナ内でアプリケーションを実行する方法
137 Before running an application, you should know what are the resources you
138 want to isolate. The default configuration is to isolate PIDs, the sysv
139 IPC and mount points. If you want to run a simple shell inside a
140 container, a basic configuration is needed, especially if you want to
141 share the rootfs. If you want to run an application like
142 <command>sshd</command>, you should provide a new network stack and a new
143 hostname. If you want to avoid conflicts with some files eg.
144 <filename>/var/run/httpd.pid</filename>, you should remount
145 <filename>/var/run</filename> with an empty directory. If you want to
146 avoid the conflicts in all the cases, you can specify a rootfs for the
147 container. The rootfs can be a directory tree, previously bind mounted
148 with the initial rootfs, so you can still use your distro but with your
149 own <filename>/etc</filename> and <filename>/home</filename>
151 アプリケーションを実行する前に、隔離したいリソースについて知っておくべきです。デフォルトの設定では、PID、sysv IPC、マウントポイントが隔離されます。コンテナ内でシンプルなシェルを実行したい場合で、特に rootfs を共有したい場合、基本的な設定が必要です。
152 もし、<command>sshd</command> のようなアプリケーションを実行したい場合、新しいネットワークスタックと、新しいホスト名を準備しなくてはなりません。もし、同じファイル (<filename>/var/run/httpd.pid</filename> 等) の衝突を避けたい場合、空の <filename>/var/run/</filename> を再度マウントしなければなりません。
153 どんな場合でも衝突を避けたい場合、コンテナ専用の rootfs を指定することができます。rootfs はディレクトリツリーとする事も可能で、前もって元の rootfs を bind マウントし、<filename>/etc</filename> や <filename>/home</filename>だけは自身のディレクトリを使って、自身のディストリビューションを使えます。
157 Here is an example of directory tree
158 for <command>sshd</command>:
160 [root@lxc sshd]$ tree -d rootfs
167 | `-- network
178 | `-- sshddd
180 | `-- empty
186 and the mount points file associated with it:
188 [root@lxc sshd]$ cat fstab
190 /lib /home/root/sshd/rootfs/lib none ro,bind 0 0
191 /bin /home/root/sshd/rootfs/bin none ro,bind 0 0
192 /usr /home/root/sshd/rootfs/usr none ro,bind 0 0
193 /sbin /home/root/sshd/rootfs/sbin none ro,bind 0 0
196 ここで、<command>sshd</command> のためのディレクトリツリーのサンプルを示しましょう。
198 [root@lxc sshd]$ tree -d rootfs
224 そして、それに対応するマウントポイントのファイルは以下のようになります。
226 [root@lxc sshd]$ cat fstab
228 /lib /home/root/sshd/rootfs/lib none ro,bind 0 0
229 /bin /home/root/sshd/rootfs/bin none ro,bind 0 0
230 /usr /home/root/sshd/rootfs/usr none ro,bind 0 0
231 /sbin /home/root/sshd/rootfs/sbin none ro,bind 0 0
237 How to run a system in a container
244 Running a system inside a container is paradoxically easier
245 than running an application. Why? Because you don't have to care
246 about the resources to be isolated, everything needs to be
247 isolated, the other resources are specified as being isolated but
248 without configuration because the container will set them
249 up. eg. the ipv4 address will be setup by the system container
250 init scripts. Here is an example of the mount points file:
252 コンテナ内でシステムを実行するのは、逆説的ではありますが、アプリケーションを実行するよりも簡単です。
253 それは、隔離するリソースについて考える必要がないからで、全てを隔離する必要があるからです。
254 他のリソースは、コンテナが設定を行うので、設定なしで隔離されるように指定されます。
255 例えば、IPv4 アドレスはコンテナの init スクリプトでシステムによってセットアップされるでしょう。
256 以下に、(システムを実行するときの) マウントポイントファイルを示します。
260 [root@lxc debian]$ cat fstab
262 /dev /home/root/debian/rootfs/dev none bind 0 0
263 /dev/pts /home/root/debian/rootfs/dev/pts none bind 0 0
267 <title><!-- Container life cycle -->コンテナのライフサイクル</title>
270 When the container is created, it contains the configuration
271 information. When a process is launched, the container will be starting
272 and running. When the last process running inside the container exits,
273 the container is stopped.
275 コンテナが作成されるとき、コンテナは設定情報を含みます。プロセスが生成されるとき、コンテナは開始し、実行されるでしょう。コンテナ内で実行されている最後のプロセスが終了したとき、コンテナは停止します。
279 In case of failure when the container is initialized, it will pass
280 through the aborting state.
282 コンテナの初期化時の失敗の場合は、(以下の図の) 中断の状態を通ります。
288 | STOPPED |<---------------
295 | STARTING |--error- |
299 --------- ---------- |
300 | RUNNING | | ABORTING | |
301 --------- ---------- |
307 | STOPPING |<------- |
310 ---------------------
316 <title><!-- Configuration -->設定</title>
319 The container is configured through a configuration
320 file, the format of the configuration file is described in
322 <refentrytitle><filename>lxc.conf</filename></refentrytitle>
323 <manvolnum>5</manvolnum>
327 コンテナは設定ファイル経由で設定します。設定の書式は
329 <refentrytitle><filename>lxc.conf</filename></refentrytitle>
330 <manvolnum>5</manvolnum>
336 <title><!-- Creating / Destroying containers -->コンテナの作成と削除</title>
339 A persistent container object can be created via the
340 <command>lxc-create</command> command. It takes a container name as
341 parameter and optional configuration file and template. The name is
342 used by the different commands to refer to this container. The
343 <command>lxc-destroy</command> command will destroy the container
346 持続性のコンテナオブジェクトは <command>lxc-create</command> コマンドで作成できます。コマンドにはコンテナ名をパラメータとして与え、オプションで設定ファイルとテンプレートを指定します。ここで指定する名前は、他のコマンドからこのコンテナを参照する際に使います。
347 <command>lxc-destroy</command> コマンドはコンテナオブジェクトを削除します。
356 <title><!-- Volatile container -->一時的な (揮発性の) コンテナ</title>
359 It is not mandatory to create a container object before starting it.
360 The container can be directly started with a configuration file as
363 コンテナを開始する前にコンテナオブジェクトを作成する必要はありません。パラメータとして設定ファイルを指定して、コンテナを直接起動できます。
368 <title><!-- Starting / Stopping container -->コンテナの起動と停止</title>
371 When the container has been created, it is ready to run an application /
372 system. This is the purpose of the <command>lxc-execute</command> and
373 <command>lxc-start</command> commands. If the container was not created
374 before starting the application, the container will use the
375 configuration file passed as parameter to the command, and if there is
376 no such parameter either, then it will use a default isolation. If the
377 application ended, the container will be stopped, but if needed the
378 <command>lxc-stop</command> command can be used to stop the container.
380 コンテナが作成されると、アプリケーションもしくはシステムを実行できます。このために使用するのが <command>lxc-execute</command> と <command>lxc-start</command> コマンドです。
381 アプリケーションを開始する前にコンテナを作成しなかった場合、コンテナはコマンドにパラメータとして渡した設定ファイルを使用します。もし、このようなパラメータもない場合は、デフォルトで指定されている通りに隔離されます。
382 アプリケーションが終了した場合、コンテナも停止します。<command>lxc-stop</command> コマンドを使って、実行中のアプリケーションを停止することもできます。
387 Running an application inside a container is not exactly the same thing
388 as running a system. For this reason, there are two different commands
389 to run an application into a container:
391 コンテナ内でアプリケーションを実行することは、正確にはシステムとして実行するのとは異なります。このため、コンテナ内でアプリケーションを実行するためのコマンドには、2 種類の違ったものがあります。
393 lxc-execute -n foo [-f config] /bin/bash
394 lxc-start -n foo [-f config] [/bin/bash]
400 The <command>lxc-execute</command> command will run the specified command
401 into a container via an intermediate process,
402 <command>lxc-init</command>.
403 This lxc-init after launching the specified command, will wait for its
404 end and all other reparented processes. (to support daemons in the
405 container). In other words, in the container,
406 <command>lxc-init</command> has PID 1 and the first process of the
407 application has PID 2.
409 <command>lxc-execute</command> コマンドは、間に <command>lxc-init</command> プロセスを介して、コンテナ内で指定したコマンドを実行します。
410 lxc-init はコマンドを実行した後、(コンテナ内でのデーモンの実行をサポートするために) 実行したコマンドと生成された全てのプロセスが終了するのを待ちます。
411 言いかえると、コンテナ内では <command>lxc-init</command> は PID 1 を持ち、アプリケーションの最初のプロセスは PID 2 をもちます。
416 The <command>lxc-start</command> command will directly run the specified
417 command in the container. The PID of the first process is 1. If no
418 command is specified <command>lxc-start</command> will run the command
419 defined in lxc.init.cmd or if not set, <filename>/sbin/init</filename> .
421 <command>lxc-start</command> コマンドは、コンテナ内の特定のコマンドを直接実行します。最初のプロセスの PID が 1 となります。
422 もし、実行するコマンドが指定されていない場合は、<command>lxc-start</command> は lxc.init.cmd で設定されたコマンドを実行します。もし lxc.init.cmd が設定されていない場合は <filename>/sbin/init</filename> を実行します。
427 To summarize, <command>lxc-execute</command> is for running an
428 application and <command>lxc-start</command> is better suited for
431 まとめると、<command>lxc-execute</command> はアプリケーションを実行するためのコマンドであり、<command>lxc-start</command> はシステムを実行するのにより適したコマンドです。
436 If the application is no longer responding, is inaccessible or is not
437 able to finish by itself, a wild <command>lxc-stop</command> command
438 will kill all the processes in the container without pity.
440 もしアプリケーションの反応がなくなった場合や、アクセスできなくなった場合、自分で終了できない場合は、荒っぽいですが、<command>lxc-stop</command> コマンドがコンテナ内の全てのプロセスを容赦なく停止させてくれるでしょう。
449 <title><!-- Connect to an available tty -->利用可能な tty への接続</title>
452 If the container is configured with ttys, it is possible to access it
453 through them. It is up to the container to provide a set of available
454 ttys to be used by the following command. When the tty is lost, it is
455 possible to reconnect to it without login again.
457 コンテナが tty を持つように設定されているならば、tty を通してコンテナにアクセスすることができます。
458 アクセスできるかどうかは、以下のコマンドが使う tty がコンテナで利用できるように設定されているか次第です。
459 tty が失われたとき、再度のログインなしでその tty に再接続することが可能です。
461 lxc-console -n foo -t 3
467 <title><!-- Freeze / Unfreeze container -->コンテナの凍結と解凍</title>
470 Sometime, it is useful to stop all the processes belonging to
471 a container, eg. for job scheduling. The commands:
476 will put all the processes in an uninteruptible state and
484 ジョブスケジューリングなどで、コンテナに属する全てのプロセスを停止する事が役に立つときがあります。
489 は、全てのプロセスを中断不可能な状態に置きます。そして、
500 This feature is enabled if the freezer cgroup v1 controller is enabled
503 この機能は、カーネルで cgroup v1 の freezer コントローラが有効になっている場合に使用できます。
508 <title><!-- Getting information about container -->
509 コンテナに関する情報の取得</title>
512 When there are a lot of containers, it is hard to follow what has been
513 created or destroyed, what is running or what are the PIDs running in a
514 specific container. For this reason, the following commands may be useful:
516 多数のコンテナが存在する場合、それらが実行されたり削除されたりすること、何が実行されていて、特定のコンテナ内で実行されている PID が何であるかをフォローするのは大変です。このような時には、以下のようなコマンドが役に立つかもしれません。
524 <command>lxc-ls</command> lists containers.
526 <command>lxc-ls</command> はコンテナをリスト表示します。
531 <command>lxc-info</command> gives information for a specific container.
533 <command>lxc-info</command> は、指定したコンテナに関する情報を表示します。
538 Here is an example on how the combination of these commands
539 allows one to list all the containers and retrieve their state.
541 ここで、以上のコマンドを組み合わせて、どのようにしたら全てのコンテナのリストと、それぞれの状態が得られるかの例を示します。
543 for i in $(lxc-ls -1); do
552 <title><!-- Monitoring container -->コンテナのモニタリング</title>
555 It is sometime useful to track the states of a container, for example to
556 monitor it or just to wait for a specific state in a script.
558 時々、コンテナの状態を追跡することが出来ると便利な事があります。例えば、状態をモニタリングしたり、スクリプト内で特定の状態を待ったりするような場合です。
563 <command>lxc-monitor</command> command will monitor one or several
564 containers. The parameter of this command accepts a regular expression
567 <command>lxc-monitor</command> コマンドは、一つもしくは複数のコンテナをモニタリングします。このコマンドのパラメータは、正規表現を受け付けます。例えば
569 lxc-monitor -n "foo|bar"
572 will monitor the states of containers named 'foo' and 'bar', and:
574 は 'foo' と 'bar' という名前のコンテナの状態をモニタリングします。そして、
579 will monitor all the containers.
581 は全てのコンテナの状態をモニタリングします。
585 For a container 'foo' starting, doing some work and exiting,
586 the output will be in the form:
588 コンテナ 'foo' が開始され、いくつか処理を行い、終了した場合、出力は以下のようになります。
590 'foo' changed state to [STARTING]
591 'foo' changed state to [RUNNING]
592 'foo' changed state to [STOPPING]
593 'foo' changed state to [STOPPED]
598 <command>lxc-wait</command> command will wait for a specific
599 state change and exit. This is useful for scripting to
600 synchronize the launch of a container or the end. The
601 parameter is an ORed combination of different states. The
602 following example shows how to wait for a container if it successfully
605 <command>lxc-wait</command> コマンドは指定した状態を待って終了します。これは、コンテナの開始や終了に同期したいスクリプトで役に立ちます。パラメータは、異なった状態の論理和 (OR) を指定します。
606 以下の例は、バックグラウンドで実行されたコンテナをどのようにして待つかを示します。
610 # launch lxc-wait in background
611 lxc-wait -n foo -s STOPPED &
614 # this command goes in background
615 lxc-execute -n foo mydaemon &
617 # block until the lxc-wait exits
618 # and lxc-wait exits when the container
621 echo "'foo' is finished"
628 <title><!-- cgroup settings for containers -->コンテナの cgroup の設定</title>
631 The container is tied with the control groups, when a container is
632 started a control group is created and associated with it. The control
633 group properties can be read and modified when the container is running
634 by using the lxc-cgroup command.
636 コンテナは control group と結合しています。コンテナを開始すると cgroup が生成され、結びつけられます。
637 cgroup のプロパティは、lxc-cgroup コマンドを使って、コンテナが実行中に読み取ったり変更したりできます。
641 <command>lxc-cgroup</command> command is used to set or get a
642 control group subsystem which is associated with a
643 container. The subsystem name is handled by the user, the
644 command won't do any syntax checking on the subsystem name, if
645 the subsystem name does not exists, the command will fail.
647 <command>lxc-cgroup</command> コマンドは、コンテナと結びつけられている control group サブシステムを設定したり、取得したりするのに使います。サブシステム名の指定はユーザが行ない、このコマンドはサブシステム名の文法チェックは一切行ないません。もし、指定したサブシステム名が存在しない場合は、コマンドの実行は失敗します。
651 lxc-cgroup -n foo cpuset.cpus
654 will display the content of this subsystem.
658 lxc-cgroup -n foo cpu.shares 512
661 will set the subsystem to the specified value.
663 は、このサブシステムに指定した値を設定します。
671 <title><!-- Author -->作者</title>
672 <para>Daniel Lezcano <email>daniel.lezcano@free.fr</email></para>
673 <para>Christian Brauner <email>christian.brauner@ubuntu.com</email></para>
674 <para>Serge Hallyn <email>serge@hallyn.com</email></para>
675 <para>Stéphane Graber <email>stgraber@ubuntu.com</email></para>
680 <!-- Keep this comment at the end of the file Local variables: mode:
681 sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil
682 sgml-always-quote-attributes:t sgml-indent-step:2 sgml-indent-data:t
683 sgml-parent-document:nil sgml-default-dtd-file:nil
684 sgml-exposed-tags:nil sgml-local-catalogs:nil
685 sgml-local-ecat-files:nil End: -->