commit 4f0efa8d7db269720192f6a4e3a2ffcbe35e30b3 · pyrox.dev/nixpkgs

+1 -1

nixos/doc/manual/administration/containers.xml

···

       29
       29
        
         independently from the host system.

     

       30
       30
        
        </para>

     

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

     

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

     

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

     

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

     

       34
       34
        
       </chapter>

+48

nixos/doc/manual/administration/declarative-containers.section.md

···

       1
       1
       +
       # Declarative Container Specification {#sec-declarative-containers}

     

       2
       2
       +
       

     

       3
       3
       +
       You can also specify containers and their configuration in the host's

     

       4
       4
       +
       `configuration.nix`. For example, the following specifies that there

     

       5
       5
       +
       shall be a container named `database` running PostgreSQL:

     

       6
       6
       +
       

     

       7
       7
       +
       ```nix

     

       8
       8
       +
       containers.database =

     

       9
       9
       +
         { config =

     

       10
       10
       +
             { config, pkgs, ... }:

     

       11
       11
       +
             { services.postgresql.enable = true;

     

       12
       12
       +
             services.postgresql.package = pkgs.postgresql_9_6;

     

       13
       13
       +
             };

     

       14
       14
       +
         };

     

       15
       15
       +
       ```

     

       16
       16
       +
       

     

       17
       17
       +
       If you run `nixos-rebuild switch`, the container will be built. If the

     

       18
       18
       +
       container was already running, it will be updated in place, without

     

       19
       19
       +
       rebooting. The container can be configured to start automatically by

     

       20
       20
       +
       setting `containers.database.autoStart = true` in its configuration.

     

       21
       21
       +
       

     

       22
       22
       +
       By default, declarative containers share the network namespace of the

     

       23
       23
       +
       host, meaning that they can listen on (privileged) ports. However, they

     

       24
       24
       +
       cannot change the network configuration. You can give a container its

     

       25
       25
       +
       own network as follows:

     

       26
       26
       +
       

     

       27
       27
       +
       ```nix

     

       28
       28
       +
       containers.database = {

     

       29
       29
       +
         privateNetwork = true;

     

       30
       30
       +
         hostAddress = "192.168.100.10";

     

       31
       31
       +
         localAddress = "192.168.100.11";

     

       32
       32
       +
       };

     

       33
       33
       +
       ```

     

       34
       34
       +
       

     

       35
       35
       +
       This gives the container a private virtual Ethernet interface with IP

     

       36
       36
       +
       address `192.168.100.11`, which is hooked up to a virtual Ethernet

     

       37
       37
       +
       interface on the host with IP address `192.168.100.10`. (See the next

     

       38
       38
       +
       section for details on container networking.)

     

       39
       39
       +
       

     

       40
       40
       +
       To disable the container, just remove it from `configuration.nix` and

     

       41
       41
       +
       run `nixos-rebuild

     

       42
       42
       +
         switch`. Note that this will not delete the root directory of the

     

       43
       43
       +
       container in `/var/lib/containers`. Containers can be destroyed using

     

       44
       44
       +
       the imperative method: `nixos-container destroy foo`.

     

       45
       45
       +
       

     

       46
       46
       +
       Declarative containers can be started and stopped using the

     

       47
       47
       +
       corresponding systemd service, e.g.

     

       48
       48
       +
       `systemctl start container@database`.

-60

nixos/doc/manual/administration/declarative-containers.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-declarative-containers">

     

       6
       6
       -
        <title>Declarative Container Specification</title>

     

       7
       7
       -
       

     

       8
       8
       -
        <para>

     

       9
       9
       -
         You can also specify containers and their configuration in the host’s

     

       10
       10
       -
         <filename>configuration.nix</filename>. For example, the following specifies

     

       11
       11
       -
         that there shall be a container named <literal>database</literal> running

     

       12
       12
       -
         PostgreSQL:

     

       13
       13
       -
       <programlisting>

     

       14
       14
       -
       containers.database =

     

       15
       15
       -
         { config =

     

       16
       16
       -
             { config, pkgs, ... }:

     

       17
       17
       -
             { <xref linkend="opt-services.postgresql.enable"/> = true;

     

       18
       18
       -
             <xref linkend="opt-services.postgresql.package"/> = pkgs.postgresql_9_6;

     

       19
       19
       -
             };

     

       20
       20
       -
         };

     

       21
       21
       -
       </programlisting>

     

       22
       22
       -
         If you run <literal>nixos-rebuild switch</literal>, the container will be

     

       23
       23
       -
         built. If the container was already running, it will be updated in place,

     

       24
       24
       -
         without rebooting. The container can be configured to start automatically by

     

       25
       25
       -
         setting <literal>containers.database.autoStart = true</literal> in its

     

       26
       26
       -
         configuration.

     

       27
       27
       -
        </para>

     

       28
       28
       -
       

     

       29
       29
       -
        <para>

     

       30
       30
       -
         By default, declarative containers share the network namespace of the host,

     

       31
       31
       -
         meaning that they can listen on (privileged) ports. However, they cannot

     

       32
       32
       -
         change the network configuration. You can give a container its own network as

     

       33
       33
       -
         follows:

     

       34
       34
       -
       <programlisting>

     

       35
       35
       -
       containers.database = {

     

       36
       36
       -
         <link linkend="opt-containers._name_.privateNetwork">privateNetwork</link> = true;

     

       37
       37
       -
         <link linkend="opt-containers._name_.hostAddress">hostAddress</link> = "192.168.100.10";

     

       38
       38
       -
         <link linkend="opt-containers._name_.localAddress">localAddress</link> = "192.168.100.11";

     

       39
       39
       -
       };

     

       40
       40
       -
       </programlisting>

     

       41
       41
       -
         This gives the container a private virtual Ethernet interface with IP address

     

       42
       42
       -
         <literal>192.168.100.11</literal>, which is hooked up to a virtual Ethernet

     

       43
       43
       -
         interface on the host with IP address <literal>192.168.100.10</literal>. (See

     

       44
       44
       -
         the next section for details on container networking.)

     

       45
       45
       -
        </para>

     

       46
       46
       -
       

     

       47
       47
       -
        <para>

     

       48
       48
       -
         To disable the container, just remove it from

     

       49
       49
       -
         <filename>configuration.nix</filename> and run <literal>nixos-rebuild

     

       50
       50
       -
         switch</literal>. Note that this will not delete the root directory of the

     

       51
       51
       -
         container in <literal>/var/lib/containers</literal>. Containers can be

     

       52
       52
       -
         destroyed using the imperative method: <literal>nixos-container destroy

     

       53
       53
       -
         foo</literal>.

     

       54
       54
       -
        </para>

     

       55
       55
       -
       

     

       56
       56
       -
        <para>

     

       57
       57
       -
         Declarative containers can be started and stopped using the corresponding

     

       58
       58
       -
         systemd service, e.g. <literal>systemctl start container@database</literal>.

     

       59
       59
       -
        </para>

     

       60
       60
       -
       </section>

+60

nixos/doc/manual/from_md/administration/declarative-containers.section.xml

···

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

     

       2
       2
       +
         <title>Declarative Container Specification</title>

     

       3
       3
       +
         <para>

     

       4
       4
       +
           You can also specify containers and their configuration in the

     

       5
       5
       +
           host’s <literal>configuration.nix</literal>. For example, the

     

       6
       6
       +
           following specifies that there shall be a container named

     

       7
       7
       +
           <literal>database</literal> running PostgreSQL:

     

       8
       8
       +
         </para>

     

       9
       9
       +
         <programlisting language="bash">

     

       10
       10
       +
       containers.database =

     

       11
       11
       +
         { config =

     

       12
       12
       +
             { config, pkgs, ... }:

     

       13
       13
       +
             { services.postgresql.enable = true;

     

       14
       14
       +
             services.postgresql.package = pkgs.postgresql_9_6;

     

       15
       15
       +
             };

     

       16
       16
       +
         };

     

       17
       17
       +
       </programlisting>

     

       18
       18
       +
         <para>

     

       19
       19
       +
           If you run <literal>nixos-rebuild switch</literal>, the container

     

       20
       20
       +
           will be built. If the container was already running, it will be

     

       21
       21
       +
           updated in place, without rebooting. The container can be configured

     

       22
       22
       +
           to start automatically by setting

     

       23
       23
       +
           <literal>containers.database.autoStart = true</literal> in its

     

       24
       24
       +
           configuration.

     

       25
       25
       +
         </para>

     

       26
       26
       +
         <para>

     

       27
       27
       +
           By default, declarative containers share the network namespace of

     

       28
       28
       +
           the host, meaning that they can listen on (privileged) ports.

     

       29
       29
       +
           However, they cannot change the network configuration. You can give

     

       30
       30
       +
           a container its own network as follows:

     

       31
       31
       +
         </para>

     

       32
       32
       +
         <programlisting language="bash">

     

       33
       33
       +
       containers.database = {

     

       34
       34
       +
         privateNetwork = true;

     

       35
       35
       +
         hostAddress = &quot;192.168.100.10&quot;;

     

       36
       36
       +
         localAddress = &quot;192.168.100.11&quot;;

     

       37
       37
       +
       };

     

       38
       38
       +
       </programlisting>

     

       39
       39
       +
         <para>

     

       40
       40
       +
           This gives the container a private virtual Ethernet interface with

     

       41
       41
       +
           IP address <literal>192.168.100.11</literal>, which is hooked up to

     

       42
       42
       +
           a virtual Ethernet interface on the host with IP address

     

       43
       43
       +
           <literal>192.168.100.10</literal>. (See the next section for details

     

       44
       44
       +
           on container networking.)

     

       45
       45
       +
         </para>

     

       46
       46
       +
         <para>

     

       47
       47
       +
           To disable the container, just remove it from

     

       48
       48
       +
           <literal>configuration.nix</literal> and run

     

       49
       49
       +
           <literal>nixos-rebuild switch</literal>. Note that this will not

     

       50
       50
       +
           delete the root directory of the container in

     

       51
       51
       +
           <literal>/var/lib/containers</literal>. Containers can be destroyed

     

       52
       52
       +
           using the imperative method:

     

       53
       53
       +
           <literal>nixos-container destroy foo</literal>.

     

       54
       54
       +
         </para>

     

       55
       55
       +
         <para>

     

       56
       56
       +
           Declarative containers can be started and stopped using the

     

       57
       57
       +
           corresponding systemd service, e.g.

     

       58
       58
       +
           <literal>systemctl start container@database</literal>.

     

       59
       59
       +
         </para>

     

       60
       60
       +
       </section>