commit 0ac3e57ac1caa8249b966acda47ae3c08e5d31f1 · pyrox.dev/nixpkgs

+1 -1

nixos/doc/manual/administration/containers.xml

···

       28
       28
        
         contrast, in the imperative approach, containers are configured and updated

     

       29
       29
        
         independently from the host system.

     

       30
       30
        
        </para>

     

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

     

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

     

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

     

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

     

       34
       34
        
       </chapter>

+115

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

···

       1
       1
       +
       # Imperative Container Management {#sec-imperative-containers}

     

       2
       2
       +
       

     

       3
       3
       +
       We'll cover imperative container management using `nixos-container`

     

       4
       4
       +
       first. Be aware that container management is currently only possible as

     

       5
       5
       +
       `root`.

     

       6
       6
       +
       

     

       7
       7
       +
       You create a container with identifier `foo` as follows:

     

       8
       8
       +
       

     

       9
       9
       +
       ```ShellSession

     

       10
       10
       +
       # nixos-container create foo

     

       11
       11
       +
       ```

     

       12
       12
       +
       

     

       13
       13
       +
       This creates the container's root directory in `/var/lib/containers/foo`

     

       14
       14
       +
       and a small configuration file in `/etc/containers/foo.conf`. It also

     

       15
       15
       +
       builds the container's initial system configuration and stores it in

     

       16
       16
       +
       `/nix/var/nix/profiles/per-container/foo/system`. You can modify the

     

       17
       17
       +
       initial configuration of the container on the command line. For

     

       18
       18
       +
       instance, to create a container that has `sshd` running, with the given

     

       19
       19
       +
       public key for `root`:

     

       20
       20
       +
       

     

       21
       21
       +
       ```ShellSession

     

       22
       22
       +
       # nixos-container create foo --config '

     

       23
       23
       +
         services.openssh.enable = true;

     

       24
       24
       +
         users.users.root.openssh.authorizedKeys.keys = ["ssh-dss AAAAB3N…"];

     

       25
       25
       +
       '

     

       26
       26
       +
       ```

     

       27
       27
       +
       

     

       28
       28
       +
       By default the next free address in the `10.233.0.0/16` subnet will be

     

       29
       29
       +
       chosen as container IP. This behavior can be altered by setting

     

       30
       30
       +
       `--host-address` and `--local-address`:

     

       31
       31
       +
       

     

       32
       32
       +
       ```ShellSession

     

       33
       33
       +
       # nixos-container create test --config-file test-container.nix \

     

       34
       34
       +
           --local-address 10.235.1.2 --host-address 10.235.1.1

     

       35
       35
       +
       ```

     

       36
       36
       +
       

     

       37
       37
       +
       Creating a container does not start it. To start the container, run:

     

       38
       38
       +
       

     

       39
       39
       +
       ```ShellSession

     

       40
       40
       +
       # nixos-container start foo

     

       41
       41
       +
       ```

     

       42
       42
       +
       

     

       43
       43
       +
       This command will return as soon as the container has booted and has

     

       44
       44
       +
       reached `multi-user.target`. On the host, the container runs within a

     

       45
       45
       +
       systemd unit called `container@container-name.service`. Thus, if

     

       46
       46
       +
       something went wrong, you can get status info using `systemctl`:

     

       47
       47
       +
       

     

       48
       48
       +
       ```ShellSession

     

       49
       49
       +
       # systemctl status container@foo

     

       50
       50
       +
       ```

     

       51
       51
       +
       

     

       52
       52
       +
       If the container has started successfully, you can log in as root using

     

       53
       53
       +
       the `root-login` operation:

     

       54
       54
       +
       

     

       55
       55
       +
       ```ShellSession

     

       56
       56
       +
       # nixos-container root-login foo

     

       57
       57
       +
       [root@foo:~]#

     

       58
       58
       +
       ```

     

       59
       59
       +
       

     

       60
       60
       +
       Note that only root on the host can do this (since there is no

     

       61
       61
       +
       authentication). You can also get a regular login prompt using the

     

       62
       62
       +
       `login` operation, which is available to all users on the host:

     

       63
       63
       +
       

     

       64
       64
       +
       ```ShellSession

     

       65
       65
       +
       # nixos-container login foo

     

       66
       66
       +
       foo login: alice

     

       67
       67
       +
       Password: ***

     

       68
       68
       +
       ```

     

       69
       69
       +
       

     

       70
       70
       +
       With `nixos-container run`, you can execute arbitrary commands in the

     

       71
       71
       +
       container:

     

       72
       72
       +
       

     

       73
       73
       +
       ```ShellSession

     

       74
       74
       +
       # nixos-container run foo -- uname -a

     

       75
       75
       +
       Linux foo 3.4.82 #1-NixOS SMP Thu Mar 20 14:44:05 UTC 2014 x86_64 GNU/Linux

     

       76
       76
       +
       ```

     

       77
       77
       +
       

     

       78
       78
       +
       There are several ways to change the configuration of the container.

     

       79
       79
       +
       First, on the host, you can edit

     

       80
       80
       +
       `/var/lib/container/name/etc/nixos/configuration.nix`, and run

     

       81
       81
       +
       

     

       82
       82
       +
       ```ShellSession

     

       83
       83
       +
       # nixos-container update foo

     

       84
       84
       +
       ```

     

       85
       85
       +
       

     

       86
       86
       +
       This will build and activate the new configuration. You can also specify

     

       87
       87
       +
       a new configuration on the command line:

     

       88
       88
       +
       

     

       89
       89
       +
       ```ShellSession

     

       90
       90
       +
       # nixos-container update foo --config '

     

       91
       91
       +
         services.httpd.enable = true;

     

       92
       92
       +
         services.httpd.adminAddr = "foo@example.org";

     

       93
       93
       +
         networking.firewall.allowedTCPPorts = [ 80 ];

     

       94
       94
       +
       '

     

       95
       95
       +
       

     

       96
       96
       +
       # curl http://$(nixos-container show-ip foo)/

     

       97
       97
       +
       <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">…

     

       98
       98
       +
       ```

     

       99
       99
       +
       

     

       100
       100
       +
       However, note that this will overwrite the container's

     

       101
       101
       +
       `/etc/nixos/configuration.nix`.

     

       102
       102
       +
       

     

       103
       103
       +
       Alternatively, you can change the configuration from within the

     

       104
       104
       +
       container itself by running `nixos-rebuild switch` inside the container.

     

       105
       105
       +
       Note that the container by default does not have a copy of the NixOS

     

       106
       106
       +
       channel, so you should run `nix-channel --update` first.

     

       107
       107
       +
       

     

       108
       108
       +
       Containers can be stopped and started using `nixos-container

     

       109
       109
       +
         stop` and `nixos-container start`, respectively, or by using

     

       110
       110
       +
       `systemctl` on the container's service unit. To destroy a container,

     

       111
       111
       +
       including its file system, do

     

       112
       112
       +
       

     

       113
       113
       +
       ```ShellSession

     

       114
       114
       +
       # nixos-container destroy foo

     

       115
       115
       +
       ```

-123

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

     

       6
       6
       -
        <title>Imperative Container Management</title>

     

       7
       7
       -
       

     

       8
       8
       -
        <para>

     

       9
       9
       -
         We’ll cover imperative container management using

     

       10
       10
       -
         <command>nixos-container</command> first. Be aware that container management

     

       11
       11
       -
         is currently only possible as <literal>root</literal>.

     

       12
       12
       -
        </para>

     

       13
       13
       -
       

     

       14
       14
       -
        <para>

     

       15
       15
       -
         You create a container with identifier <literal>foo</literal> as follows:

     

       16
       16
       -
       <screen>

     

       17
       17
       -
       <prompt># </prompt>nixos-container create <replaceable>foo</replaceable>

     

       18
       18
       -
       </screen>

     

       19
       19
       -
         This creates the container’s root directory in

     

       20
       20
       -
         <filename>/var/lib/containers/<replaceable>foo</replaceable></filename> and a small configuration file

     

       21
       21
       -
         in <filename>/etc/containers/<replaceable>foo</replaceable>.conf</filename>. It also builds the

     

       22
       22
       -
         container’s initial system configuration and stores it in

     

       23
       23
       -
         <filename>/nix/var/nix/profiles/per-container/<replaceable>foo</replaceable>/system</filename>. You can

     

       24
       24
       -
         modify the initial configuration of the container on the command line. For

     

       25
       25
       -
         instance, to create a container that has <command>sshd</command> running,

     

       26
       26
       -
         with the given public key for <literal>root</literal>:

     

       27
       27
       -
       <screen>

     

       28
       28
       -
       <prompt># </prompt>nixos-container create <replaceable>foo</replaceable> --config '

     

       29
       29
       -
         <xref linkend="opt-services.openssh.enable"/> = true;

     

       30
       30
       -
         <link linkend="opt-users.users._name_.openssh.authorizedKeys.keys">users.users.root.openssh.authorizedKeys.keys</link> = ["ssh-dss AAAAB3N…"];

     

       31
       31
       -
       '

     

       32
       32
       -
       </screen>

     

       33
       33
       -
         By default the next free address in the <literal>10.233.0.0/16</literal> subnet will be chosen

     

       34
       34
       -
         as container IP. This behavior can be altered by setting <literal>--host-address</literal> and

     

       35
       35
       -
         <literal>--local-address</literal>:

     

       36
       36
       -
       <screen>

     

       37
       37
       -
       <prompt># </prompt>nixos-container create test --config-file test-container.nix \

     

       38
       38
       -
           --local-address 10.235.1.2 --host-address 10.235.1.1

     

       39
       39
       -
       </screen>

     

       40
       40
       -
        </para>

     

       41
       41
       -
       

     

       42
       42
       -
        <para>

     

       43
       43
       -
         Creating a container does not start it. To start the container, run:

     

       44
       44
       -
       <screen>

     

       45
       45
       -
       <prompt># </prompt>nixos-container start <replaceable>foo</replaceable>

     

       46
       46
       -
       </screen>

     

       47
       47
       -
         This command will return as soon as the container has booted and has reached

     

       48
       48
       -
         <literal>multi-user.target</literal>. On the host, the container runs within

     

       49
       49
       -
         a systemd unit called

     

       50
       50
       -
         <literal>container@<replaceable>container-name</replaceable>.service</literal>.

     

       51
       51
       -
         Thus, if something went wrong, you can get status info using

     

       52
       52
       -
         <command>systemctl</command>:

     

       53
       53
       -
       <screen>

     

       54
       54
       -
       <prompt># </prompt>systemctl status container@<replaceable>foo</replaceable>

     

       55
       55
       -
       </screen>

     

       56
       56
       -
        </para>

     

       57
       57
       -
       

     

       58
       58
       -
        <para>

     

       59
       59
       -
         If the container has started successfully, you can log in as root using the

     

       60
       60
       -
         <command>root-login</command> operation:

     

       61
       61
       -
       <screen>

     

       62
       62
       -
       <prompt># </prompt>nixos-container root-login <replaceable>foo</replaceable>

     

       63
       63
       -
       <prompt>[root@foo:~]#</prompt>

     

       64
       64
       -
       </screen>

     

       65
       65
       -
         Note that only root on the host can do this (since there is no

     

       66
       66
       -
         authentication). You can also get a regular login prompt using the

     

       67
       67
       -
         <command>login</command> operation, which is available to all users on the

     

       68
       68
       -
         host:

     

       69
       69
       -
       <screen>

     

       70
       70
       -
       <prompt># </prompt>nixos-container login <replaceable>foo</replaceable>

     

       71
       71
       -
       foo login: alice

     

       72
       72
       -
       Password: ***

     

       73
       73
       -
       </screen>

     

       74
       74
       -
         With <command>nixos-container run</command>, you can execute arbitrary

     

       75
       75
       -
         commands in the container:

     

       76
       76
       -
       <screen>

     

       77
       77
       -
       <prompt># </prompt>nixos-container run <replaceable>foo</replaceable> -- uname -a

     

       78
       78
       -
       Linux foo 3.4.82 #1-NixOS SMP Thu Mar 20 14:44:05 UTC 2014 x86_64 GNU/Linux

     

       79
       79
       -
       </screen>

     

       80
       80
       -
        </para>

     

       81
       81
       -
       

     

       82
       82
       -
        <para>

     

       83
       83
       -
         There are several ways to change the configuration of the container. First,

     

       84
       84
       -
         on the host, you can edit

     

       85
       85
       -
         <literal>/var/lib/container/<replaceable>name</replaceable>/etc/nixos/configuration.nix</literal>,

     

       86
       86
       -
         and run

     

       87
       87
       -
       <screen>

     

       88
       88
       -
       <prompt># </prompt>nixos-container update <replaceable>foo</replaceable>

     

       89
       89
       -
       </screen>

     

       90
       90
       -
         This will build and activate the new configuration. You can also specify a

     

       91
       91
       -
         new configuration on the command line:

     

       92
       92
       -
       <screen>

     

       93
       93
       -
       <prompt># </prompt>nixos-container update <replaceable>foo</replaceable> --config '

     

       94
       94
       -
         <xref linkend="opt-services.httpd.enable"/> = true;

     

       95
       95
       -
         <xref linkend="opt-services.httpd.adminAddr"/> = "foo@example.org";

     

       96
       96
       -
         <xref linkend="opt-networking.firewall.allowedTCPPorts"/> = [ 80 ];

     

       97
       97
       -
       '

     

       98
       98
       -
       

     

       99
       99
       -
       <prompt># </prompt>curl http://$(nixos-container show-ip <replaceable>foo</replaceable>)/

     

       100
       100
       -
       &lt;!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">…

     

       101
       101
       -
       </screen>

     

       102
       102
       -
         However, note that this will overwrite the container’s

     

       103
       103
       -
         <filename>/etc/nixos/configuration.nix</filename>.

     

       104
       104
       -
        </para>

     

       105
       105
       -
       

     

       106
       106
       -
        <para>

     

       107
       107
       -
         Alternatively, you can change the configuration from within the container

     

       108
       108
       -
         itself by running <command>nixos-rebuild switch</command> inside the

     

       109
       109
       -
         container. Note that the container by default does not have a copy of the

     

       110
       110
       -
         NixOS channel, so you should run <command>nix-channel --update</command>

     

       111
       111
       -
         first.

     

       112
       112
       -
        </para>

     

       113
       113
       -
       

     

       114
       114
       -
        <para>

     

       115
       115
       -
         Containers can be stopped and started using <literal>nixos-container

     

       116
       116
       -
         stop</literal> and <literal>nixos-container start</literal>, respectively, or

     

       117
       117
       -
         by using <command>systemctl</command> on the container’s service unit. To

     

       118
       118
       -
         destroy a container, including its file system, do

     

       119
       119
       -
       <screen>

     

       120
       120
       -
       <prompt># </prompt>nixos-container destroy <replaceable>foo</replaceable>

     

       121
       121
       -
       </screen>

     

       122
       122
       -
        </para>

     

       123
       123
       -
       </section>

+131

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

···

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

     

       2
       2
       +
         <title>Imperative Container Management</title>

     

       3
       3
       +
         <para>

     

       4
       4
       +
           We’ll cover imperative container management using

     

       5
       5
       +
           <literal>nixos-container</literal> first. Be aware that container

     

       6
       6
       +
           management is currently only possible as <literal>root</literal>.

     

       7
       7
       +
         </para>

     

       8
       8
       +
         <para>

     

       9
       9
       +
           You create a container with identifier <literal>foo</literal> as

     

       10
       10
       +
           follows:

     

       11
       11
       +
         </para>

     

       12
       12
       +
         <programlisting>

     

       13
       13
       +
       # nixos-container create foo

     

       14
       14
       +
       </programlisting>

     

       15
       15
       +
         <para>

     

       16
       16
       +
           This creates the container’s root directory in

     

       17
       17
       +
           <literal>/var/lib/containers/foo</literal> and a small configuration

     

       18
       18
       +
           file in <literal>/etc/containers/foo.conf</literal>. It also builds

     

       19
       19
       +
           the container’s initial system configuration and stores it in

     

       20
       20
       +
           <literal>/nix/var/nix/profiles/per-container/foo/system</literal>.

     

       21
       21
       +
           You can modify the initial configuration of the container on the

     

       22
       22
       +
           command line. For instance, to create a container that has

     

       23
       23
       +
           <literal>sshd</literal> running, with the given public key for

     

       24
       24
       +
           <literal>root</literal>:

     

       25
       25
       +
         </para>

     

       26
       26
       +
         <programlisting>

     

       27
       27
       +
       # nixos-container create foo --config '

     

       28
       28
       +
         services.openssh.enable = true;

     

       29
       29
       +
         users.users.root.openssh.authorizedKeys.keys = [&quot;ssh-dss AAAAB3N…&quot;];

     

       30
       30
       +
       '

     

       31
       31
       +
       </programlisting>

     

       32
       32
       +
         <para>

     

       33
       33
       +
           By default the next free address in the

     

       34
       34
       +
           <literal>10.233.0.0/16</literal> subnet will be chosen as container

     

       35
       35
       +
           IP. This behavior can be altered by setting

     

       36
       36
       +
           <literal>--host-address</literal> and

     

       37
       37
       +
           <literal>--local-address</literal>:

     

       38
       38
       +
         </para>

     

       39
       39
       +
         <programlisting>

     

       40
       40
       +
       # nixos-container create test --config-file test-container.nix \

     

       41
       41
       +
           --local-address 10.235.1.2 --host-address 10.235.1.1

     

       42
       42
       +
       </programlisting>

     

       43
       43
       +
         <para>

     

       44
       44
       +
           Creating a container does not start it. To start the container, run:

     

       45
       45
       +
         </para>

     

       46
       46
       +
         <programlisting>

     

       47
       47
       +
       # nixos-container start foo

     

       48
       48
       +
       </programlisting>

     

       49
       49
       +
         <para>

     

       50
       50
       +
           This command will return as soon as the container has booted and has

     

       51
       51
       +
           reached <literal>multi-user.target</literal>. On the host, the

     

       52
       52
       +
           container runs within a systemd unit called

     

       53
       53
       +
           <literal>container@container-name.service</literal>. Thus, if

     

       54
       54
       +
           something went wrong, you can get status info using

     

       55
       55
       +
           <literal>systemctl</literal>:

     

       56
       56
       +
         </para>

     

       57
       57
       +
         <programlisting>

     

       58
       58
       +
       # systemctl status container@foo

     

       59
       59
       +
       </programlisting>

     

       60
       60
       +
         <para>

     

       61
       61
       +
           If the container has started successfully, you can log in as root

     

       62
       62
       +
           using the <literal>root-login</literal> operation:

     

       63
       63
       +
         </para>

     

       64
       64
       +
         <programlisting>

     

       65
       65
       +
       # nixos-container root-login foo

     

       66
       66
       +
       [root@foo:~]#

     

       67
       67
       +
       </programlisting>

     

       68
       68
       +
         <para>

     

       69
       69
       +
           Note that only root on the host can do this (since there is no

     

       70
       70
       +
           authentication). You can also get a regular login prompt using the

     

       71
       71
       +
           <literal>login</literal> operation, which is available to all users

     

       72
       72
       +
           on the host:

     

       73
       73
       +
         </para>

     

       74
       74
       +
         <programlisting>

     

       75
       75
       +
       # nixos-container login foo

     

       76
       76
       +
       foo login: alice

     

       77
       77
       +
       Password: ***

     

       78
       78
       +
       </programlisting>

     

       79
       79
       +
         <para>

     

       80
       80
       +
           With <literal>nixos-container run</literal>, you can execute

     

       81
       81
       +
           arbitrary commands in the container:

     

       82
       82
       +
         </para>

     

       83
       83
       +
         <programlisting>

     

       84
       84
       +
       # nixos-container run foo -- uname -a

     

       85
       85
       +
       Linux foo 3.4.82 #1-NixOS SMP Thu Mar 20 14:44:05 UTC 2014 x86_64 GNU/Linux

     

       86
       86
       +
       </programlisting>

     

       87
       87
       +
         <para>

     

       88
       88
       +
           There are several ways to change the configuration of the container.

     

       89
       89
       +
           First, on the host, you can edit

     

       90
       90
       +
           <literal>/var/lib/container/name/etc/nixos/configuration.nix</literal>,

     

       91
       91
       +
           and run

     

       92
       92
       +
         </para>

     

       93
       93
       +
         <programlisting>

     

       94
       94
       +
       # nixos-container update foo

     

       95
       95
       +
       </programlisting>

     

       96
       96
       +
         <para>

     

       97
       97
       +
           This will build and activate the new configuration. You can also

     

       98
       98
       +
           specify a new configuration on the command line:

     

       99
       99
       +
         </para>

     

       100
       100
       +
         <programlisting>

     

       101
       101
       +
       # nixos-container update foo --config '

     

       102
       102
       +
         services.httpd.enable = true;

     

       103
       103
       +
         services.httpd.adminAddr = &quot;foo@example.org&quot;;

     

       104
       104
       +
         networking.firewall.allowedTCPPorts = [ 80 ];

     

       105
       105
       +
       '

     

       106
       106
       +
       

     

       107
       107
       +
       # curl http://$(nixos-container show-ip foo)/

     

       108
       108
       +
       &lt;!DOCTYPE HTML PUBLIC &quot;-//W3C//DTD HTML 3.2 Final//EN&quot;&gt;…

     

       109
       109
       +
       </programlisting>

     

       110
       110
       +
         <para>

     

       111
       111
       +
           However, note that this will overwrite the container’s

     

       112
       112
       +
           <literal>/etc/nixos/configuration.nix</literal>.

     

       113
       113
       +
         </para>

     

       114
       114
       +
         <para>

     

       115
       115
       +
           Alternatively, you can change the configuration from within the

     

       116
       116
       +
           container itself by running <literal>nixos-rebuild switch</literal>

     

       117
       117
       +
           inside the container. Note that the container by default does not

     

       118
       118
       +
           have a copy of the NixOS channel, so you should run

     

       119
       119
       +
           <literal>nix-channel --update</literal> first.

     

       120
       120
       +
         </para>

     

       121
       121
       +
         <para>

     

       122
       122
       +
           Containers can be stopped and started using

     

       123
       123
       +
           <literal>nixos-container stop</literal> and

     

       124
       124
       +
           <literal>nixos-container start</literal>, respectively, or by using

     

       125
       125
       +
           <literal>systemctl</literal> on the container’s service unit. To

     

       126
       126
       +
           destroy a container, including its file system, do

     

       127
       127
       +
         </para>

     

       128
       128
       +
         <programlisting>

     

       129
       129
       +
       # nixos-container destroy foo

     

       130
       130
       +
       </programlisting>

     

       131
       131
       +
       </section>