commit 9b52df304bb8e4f2ef0f00ad1cdabcc3243e7733 · pyrox.dev/nixpkgs

+44

nixos/doc/manual/administration/container-networking.section.md

···

       1
       1
       +
       # Container Networking {#sec-container-networking}

     

       2
       2
       +
       

     

       3
       3
       +
       When you create a container using `nixos-container create`, it gets it

     

       4
       4
       +
       own private IPv4 address in the range `10.233.0.0/16`. You can get the

     

       5
       5
       +
       container's IPv4 address as follows:

     

       6
       6
       +
       

     

       7
       7
       +
       ```ShellSession

     

       8
       8
       +
       # nixos-container show-ip foo

     

       9
       9
       +
       10.233.4.2

     

       10
       10
       +
       

     

       11
       11
       +
       $ ping -c1 10.233.4.2

     

       12
       12
       +
       64 bytes from 10.233.4.2: icmp_seq=1 ttl=64 time=0.106 ms

     

       13
       13
       +
       ```

     

       14
       14
       +
       

     

       15
       15
       +
       Networking is implemented using a pair of virtual Ethernet devices. The

     

       16
       16
       +
       network interface in the container is called `eth0`, while the matching

     

       17
       17
       +
       interface in the host is called `ve-container-name` (e.g., `ve-foo`).

     

       18
       18
       +
       The container has its own network namespace and the `CAP_NET_ADMIN`

     

       19
       19
       +
       capability, so it can perform arbitrary network configuration such as

     

       20
       20
       +
       setting up firewall rules, without affecting or having access to the

     

       21
       21
       +
       host's network.

     

       22
       22
       +
       

     

       23
       23
       +
       By default, containers cannot talk to the outside network. If you want

     

       24
       24
       +
       that, you should set up Network Address Translation (NAT) rules on the

     

       25
       25
       +
       host to rewrite container traffic to use your external IP address. This

     

       26
       26
       +
       can be accomplished using the following configuration on the host:

     

       27
       27
       +
       

     

       28
       28
       +
       ```nix

     

       29
       29
       +
       networking.nat.enable = true;

     

       30
       30
       +
       networking.nat.internalInterfaces = ["ve-+"];

     

       31
       31
       +
       networking.nat.externalInterface = "eth0";

     

       32
       32
       +
       ```

     

       33
       33
       +
       

     

       34
       34
       +
       where `eth0` should be replaced with the desired external interface.

     

       35
       35
       +
       Note that `ve-+` is a wildcard that matches all container interfaces.

     

       36
       36
       +
       

     

       37
       37
       +
       If you are using Network Manager, you need to explicitly prevent it from

     

       38
       38
       +
       managing container interfaces:

     

       39
       39
       +
       

     

       40
       40
       +
       ```nix

     

       41
       41
       +
       networking.networkmanager.unmanaged = [ "interface-name:ve-*" ];

     

       42
       42
       +
       ```

     

       43
       43
       +
       

     

       44
       44
       +
       You may need to restart your system for the changes to take effect.

-59

nixos/doc/manual/administration/container-networking.xml

···

       1
       1
       -
       <section  xmlns="http://docbook.org/ns/docbook"

     

       2
       2
       -
                 xmlns:xlink="http://www.w3.org/1999/xlink"

     

       3
       3
       -
                 xmlns:xi="http://www.w3.org/2001/XInclude"

     

       4
       4
       -
                 version="5.0"

     

       5
       5
       -
                 xml:id="sec-container-networking">

     

       6
       6
       -
        <title>Container Networking</title>

     

       7
       7
       -
       

     

       8
       8
       -
        <para>

     

       9
       9
       -
         When you create a container using <literal>nixos-container create</literal>,

     

       10
       10
       -
         it gets it own private IPv4 address in the range

     

       11
       11
       -
         <literal>10.233.0.0/16</literal>. You can get the container’s IPv4 address

     

       12
       12
       -
         as follows:

     

       13
       13
       -
       <screen>

     

       14
       14
       -
       <prompt># </prompt>nixos-container show-ip foo

     

       15
       15
       -
       10.233.4.2

     

       16
       16
       -
       

     

       17
       17
       -
       <prompt>$ </prompt>ping -c1 10.233.4.2

     

       18
       18
       -
       64 bytes from 10.233.4.2: icmp_seq=1 ttl=64 time=0.106 ms

     

       19
       19
       -
       </screen>

     

       20
       20
       -
        </para>

     

       21
       21
       -
       

     

       22
       22
       -
        <para>

     

       23
       23
       -
         Networking is implemented using a pair of virtual Ethernet devices. The

     

       24
       24
       -
         network interface in the container is called <literal>eth0</literal>, while

     

       25
       25
       -
         the matching interface in the host is called

     

       26
       26
       -
         <literal>ve-<replaceable>container-name</replaceable></literal> (e.g.,

     

       27
       27
       -
         <literal>ve-foo</literal>). The container has its own network namespace and

     

       28
       28
       -
         the <literal>CAP_NET_ADMIN</literal> capability, so it can perform arbitrary

     

       29
       29
       -
         network configuration such as setting up firewall rules, without affecting or

     

       30
       30
       -
         having access to the host’s network.

     

       31
       31
       -
        </para>

     

       32
       32
       -
       

     

       33
       33
       -
        <para>

     

       34
       34
       -
         By default, containers cannot talk to the outside network. If you want that,

     

       35
       35
       -
         you should set up Network Address Translation (NAT) rules on the host to

     

       36
       36
       -
         rewrite container traffic to use your external IP address. This can be

     

       37
       37
       -
         accomplished using the following configuration on the host:

     

       38
       38
       -
       <programlisting>

     

       39
       39
       -
       <xref linkend="opt-networking.nat.enable"/> = true;

     

       40
       40
       -
       <xref linkend="opt-networking.nat.internalInterfaces"/> = ["ve-+"];

     

       41
       41
       -
       <xref linkend="opt-networking.nat.externalInterface"/> = "eth0";

     

       42
       42
       -
       </programlisting>

     

       43
       43
       -
         where <literal>eth0</literal> should be replaced with the desired external

     

       44
       44
       -
         interface. Note that <literal>ve-+</literal> is a wildcard that matches all

     

       45
       45
       -
         container interfaces.

     

       46
       46
       -
        </para>

     

       47
       47
       -
       

     

       48
       48
       -
        <para>

     

       49
       49
       -
         If you are using Network Manager, you need to explicitly prevent it from

     

       50
       50
       -
         managing container interfaces:

     

       51
       51
       -
       <programlisting>

     

       52
       52
       -
       networking.networkmanager.unmanaged = [ "interface-name:ve-*" ];

     

       53
       53
       -
       </programlisting>

     

       54
       54
       -
        </para>

     

       55
       55
       -
       

     

       56
       56
       -
        <para>

     

       57
       57
       -
         You may need to restart your system for the changes to take effect.

     

       58
       58
       -
        </para>

     

       59
       59
       -
       </section>

+1 -1

nixos/doc/manual/administration/containers.xml

···

       30
       30
        
        </para>

     

       31
       31
        
        <xi:include href="../from_md/administration/imperative-containers.section.xml" />

     

       32
       32
        
        <xi:include href="../from_md/administration/declarative-containers.section.xml" />

     

       33
       33
       -
        <xi:include href="container-networking.xml" />

     

       33
       33
       +
        <xi:include href="../from_md/administration/container-networking.section.xml" />

     

       34
       34
        
       </chapter>

+54

nixos/doc/manual/from_md/administration/container-networking.section.xml

···

       1
       1
       +
       <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-container-networking">

     

       2
       2
       +
         <title>Container Networking</title>

     

       3
       3
       +
         <para>

     

       4
       4
       +
           When you create a container using

     

       5
       5
       +
           <literal>nixos-container create</literal>, it gets it own private

     

       6
       6
       +
           IPv4 address in the range <literal>10.233.0.0/16</literal>. You can

     

       7
       7
       +
           get the container’s IPv4 address as follows:

     

       8
       8
       +
         </para>

     

       9
       9
       +
         <programlisting>

     

       10
       10
       +
       # nixos-container show-ip foo

     

       11
       11
       +
       10.233.4.2

     

       12
       12
       +
       

     

       13
       13
       +
       $ ping -c1 10.233.4.2

     

       14
       14
       +
       64 bytes from 10.233.4.2: icmp_seq=1 ttl=64 time=0.106 ms

     

       15
       15
       +
       </programlisting>

     

       16
       16
       +
         <para>

     

       17
       17
       +
           Networking is implemented using a pair of virtual Ethernet devices.

     

       18
       18
       +
           The network interface in the container is called

     

       19
       19
       +
           <literal>eth0</literal>, while the matching interface in the host is

     

       20
       20
       +
           called <literal>ve-container-name</literal> (e.g.,

     

       21
       21
       +
           <literal>ve-foo</literal>). The container has its own network

     

       22
       22
       +
           namespace and the <literal>CAP_NET_ADMIN</literal> capability, so it

     

       23
       23
       +
           can perform arbitrary network configuration such as setting up

     

       24
       24
       +
           firewall rules, without affecting or having access to the host’s

     

       25
       25
       +
           network.

     

       26
       26
       +
         </para>

     

       27
       27
       +
         <para>

     

       28
       28
       +
           By default, containers cannot talk to the outside network. If you

     

       29
       29
       +
           want that, you should set up Network Address Translation (NAT) rules

     

       30
       30
       +
           on the host to rewrite container traffic to use your external IP

     

       31
       31
       +
           address. This can be accomplished using the following configuration

     

       32
       32
       +
           on the host:

     

       33
       33
       +
         </para>

     

       34
       34
       +
         <programlisting language="bash">

     

       35
       35
       +
       networking.nat.enable = true;

     

       36
       36
       +
       networking.nat.internalInterfaces = [&quot;ve-+&quot;];

     

       37
       37
       +
       networking.nat.externalInterface = &quot;eth0&quot;;

     

       38
       38
       +
       </programlisting>

     

       39
       39
       +
         <para>

     

       40
       40
       +
           where <literal>eth0</literal> should be replaced with the desired

     

       41
       41
       +
           external interface. Note that <literal>ve-+</literal> is a wildcard

     

       42
       42
       +
           that matches all container interfaces.

     

       43
       43
       +
         </para>

     

       44
       44
       +
         <para>

     

       45
       45
       +
           If you are using Network Manager, you need to explicitly prevent it

     

       46
       46
       +
           from managing container interfaces:

     

       47
       47
       +
         </para>

     

       48
       48
       +
         <programlisting language="bash">

     

       49
       49
       +
       networking.networkmanager.unmanaged = [ &quot;interface-name:ve-*&quot; ];

     

       50
       50
       +
       </programlisting>

     

       51
       51
       +
         <para>

     

       52
       52
       +
           You may need to restart your system for the changes to take effect.

     

       53
       53
       +
         </para>

     

       54
       54
       +
       </section>