doc/ja/lxc-user-nic.sgml.in

   1 <!--
   2
   3 lxc: linux Container library
   4
   5 (C) Copyright Canonical Ltd. 2013
   6
   7 Authors:
   8 Serge Hallyn <serge.hallyn@ubuntu.com>
   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-user-nic</refentrytitle>
  41     <manvolnum>1</manvolnum>
  42   </refmeta>
  43
  44   <refnamediv>
  45     <refname>lxc-user-nic</refname>
  46
  47     <refpurpose>
  48       <!--
  49       Manage nics in another namespace
  50       -->
  51       現在と異なるネットワーク名前空間の NIC を管理する
  52     </refpurpose>
  53   </refnamediv>
  54
  55   <refsynopsisdiv>
  56     <cmdsynopsis>
  57       <command>lxc-user-nic</command>
  58       <command>create</command>
  59       <arg choice="req"><replaceable>lxcpath</replaceable></arg>
  60       <arg choice="req"><replaceable>name</replaceable></arg>
  61       <arg choice="req"><replaceable>pid</replaceable></arg>
  62       <arg choice="req"><replaceable>type</replaceable></arg>
  63       <arg choice="req"><replaceable>bridge</replaceable></arg>
  64       <arg choice="opt"><replaceable>container nicname</replaceable></arg>
  65     </cmdsynopsis>
  66
  67      <cmdsynopsis>
  68       <command>lxc-user-nic</command>
  69       <command>delete</command>
  70       <arg choice="req"><replaceable>lxcpath</replaceable></arg>
  71       <arg choice="req"><replaceable>name</replaceable></arg>
  72       <arg choice="req"><replaceable>path to network namespace</replaceable></arg>
  73       <arg choice="req"><replaceable>type</replaceable></arg>
  74       <arg choice="req"><replaceable>bridge</replaceable></arg>
  75       <arg choice="req"><replaceable>container nicname</replaceable></arg>
  76     </cmdsynopsis>
  77   </refsynopsisdiv>
  78
  79   <refsect1>
  80     <title><!-- Description -->説明</title>
  81
  82     <para>
  83       <!--
  84       <command>lxc-user-nic</command> is a setuid-root program with which
  85       unprivileged users may create network interfaces for use by a
  86       lxc container.
  87       -->
  88       <command>lxc-user-nic</command> は root に setuid されたプログラムで、lxc コンテナが使うネットワークインターフェースを、特権を持たないユーザが作成できます。
  89     </para>
  90     <para>
  91       <!--
  92       It will consult the configuration file <filename>@LXC_USERNIC_CONF@</filename>
  93       to determine the number of interfaces which the calling user is allowed to
  94       create, and which bridge he may attach them to.  It tracks the
  95       number of interfaces each user has created using the file
  96       <filename>@LXC_USERNIC_DB@</filename>.  It ensures that the calling
  97       user is privileged over the network namespace to which the interface
  98       will be attached.
  99       <command>lxc-user-nic</command> also allows to delete network devices.
 100       Currently only ovs ports can be deleted.
 101       -->
 102       このプログラムは、<filename>@LXC_USERNIC_CONF@</filename> という設定ファイルを参照して、呼び出したユーザが作成することができるインターフェースの数と、どのブリッジに接続するかを決定します。
 103       また、ユーザが作成したインターフェースの数を <filename>@LXC_USERNIC_DB@</filename> を使ってチェックします。
 104       これにより、呼び出したユーザが、インターフェースを割り当てるネットワーク名前空間上で特権を持つことが保証されます。
 105       <command>lxc-user-nic</command> はネットワークデバイスを削除することもできます。
 106       現時点では ovs ポートの削除のみ可能です。
 107     </para>
 108
 109   </refsect1>
 110
 111   <refsect1>
 112
 113     <title><!-- Options -->オプション</title>
 114
 115     <variablelist>
 116       <varlistentry>
 117         <term>
 118           <option><replaceable>lxcpath</replaceable></option>
 119         </term>
 120         <listitem>
 121           <para>
 122             <!--
 123           The path of the container. This is currently not used.
 124               -->
 125             すべてのコンテナが保存されるパス。これは現在使われていません。
 126           </para>
 127         </listitem>
 128       </varlistentry>
 129
 130       <varlistentry>
 131         <term>
 132           <option><replaceable>name</replaceable></option>
 133         </term>
 134         <listitem>
 135           <para>
 136             <!--
 137           The name of the container. This is currently not used.
 138               -->
 139             コンテナ名。これは現在使われていません。
 140           </para>
 141         </listitem>
 142       </varlistentry>
 143
 144       <varlistentry>
 145         <term>
 146           <option><replaceable>pid</replaceable></option>
 147         </term>
 148         <listitem>
 149           <para>
 150             <!--
 151           The process id for the task to whose network namespace the interface
 152           should be attached.
 153               -->
 154             インターフェースを割り当てたいネットワーク名前空間を持つタスクのプロセス ID。
 155           </para>
 156         </listitem>
 157       </varlistentry>
 158
 159       <varlistentry>
 160         <term>
 161           <option><replaceable>type</replaceable></option>
 162         </term>
 163         <listitem>
 164           <para>
 165             <!--
 166           The network interface type to attach. Currently only veth is
 167           supported.  With this type, two interfaces representing each
 168           tunnel endpoint are created.  One endpoint will be attached
 169           to the specified bridge, while the other will be passed into
 170           the container.
 171               -->
 172             割り当てるネットワークインターフェースのタイプ。現時点では、veth のみサポートされます。
 173             このタイプを指定すると、それぞれがトンネルのエンドポイントとなる 2 つのインターフェースが作成されます。
 174             一方のエンドポイントは指定したブリッジに接続され、もう一方はコンテナに割り当てられます。
 175           </para>
 176         </listitem>
 177       </varlistentry>
 178
 179       <varlistentry>
 180         <term>
 181           <option><replaceable>bridge</replaceable></option>
 182         </term>
 183         <listitem>
 184           <para>
 185             <!--
 186           The bridge to which to attach the network interface, for
 187           instance <filename>lxcbr0</filename>.
 188               -->
 189             ネットワークインターフェースを接続するブリッジ。
 190             例えば <filename>lxcbr0</filename> のように指定します。
 191           </para>
 192         </listitem>
 193       </varlistentry>
 194
 195       <varlistentry>
 196         <term>
 197           <option><replaceable>container nicname</replaceable></option>
 198         </term>
 199         <listitem>
 200           <para>
 201             <!--
 202           The desired interface name in the container. This will be
 203           <filename>eth0</filename> if unspecified.
 204           -->
 205             コンテナ内に作られるインターフェースの名前。
 206             もし指定しない場合、<filename>eth0</filename> となります。
 207           </para>
 208         </listitem>
 209       </varlistentry>
 210
 211       <varlistentry>
 212         <term>
 213           <option><replaceable>path to network namespace</replaceable></option>
 214         </term>
 215         <listitem>
 216           <para>
 217             <!--
 218           A path to open to get a file descriptor for the target
 219           network namespace.
 220           This is only relevant when an veth device is deleted.
 221               -->
 222             対象のネットワーク名前空間のファイルディスクリプタを取得するために open するためのパス。
 223             これは veth デバイスを削除するときのみ関係します。
 224           </para>
 225         </listitem>
 226       </varlistentry>
 227
 228     </variablelist>
 229
 230   </refsect1>
 231
 232   <refsect1>
 233     <title>See Also</title>
 234
 235     <simpara>
 236       <citerefentry>
 237         <refentrytitle><command>lxc</command></refentrytitle>
 238         <manvolnum>1</manvolnum>
 239       </citerefentry>,
 240
 241       <citerefentry>
 242         <refentrytitle><command>lxc-start</command></refentrytitle>
 243         <manvolnum>1</manvolnum>
 244       </citerefentry>,
 245
 246       <citerefentry>
 247         <refentrytitle><command>lxc-usernet</command></refentrytitle>
 248         <manvolnum>5</manvolnum>
 249       </citerefentry>
 250     </simpara>
 251    </refsect1>
 252
 253   <refsect1>
 254     <title><!-- Author -->作者</title>
 255     <para>Christian Brauner <email>christian@brauner.io</email></para>
 256     <para>Serge Hallyn <email>serge@hallyn.com</email></para>
 257     <para>Daniel Lezcano <email>daniel.lezcano@free.fr</email></para>
 258   </refsect1>
 259
 260 </refentry>
 261
 262 <!-- Keep this comment at the end of the file
 263 Local variables:
 264 mode: sgml
 265 sgml-omittag:t
 266 sgml-shorttag:t
 267 sgml-minimize-attributes:nil
 268 sgml-always-quote-attributes:t
 269 sgml-indent-step:2
 270 sgml-indent-data:t
 271 sgml-parent-document:nil
 272 sgml-default-dtd-file:nil
 273 sgml-exposed-tags:nil
 274 sgml-local-catalogs:nil
 275 sgml-local-ecat-files:nil
 276 End:
 277 -->