diff options
author | Bobby Rong <rjl931189261@126.com> | 2021-07-02 11:57:33 +0800 |
---|---|---|
committer | Bobby Rong <rjl931189261@126.com> | 2021-07-02 11:57:33 +0800 |
commit | 0ac3e57ac1caa8249b966acda47ae3c08e5d31f1 (patch) | |
tree | c0415eb3faa2affcbbe66a05e0dd21684fb75dfd /nixos/doc/manual | |
parent | d8079260a3028ae3221d7a5467443ee3a9edd2b8 (diff) | |
download | nixpkgs-0ac3e57ac1caa8249b966acda47ae3c08e5d31f1.tar nixpkgs-0ac3e57ac1caa8249b966acda47ae3c08e5d31f1.tar.gz nixpkgs-0ac3e57ac1caa8249b966acda47ae3c08e5d31f1.tar.bz2 nixpkgs-0ac3e57ac1caa8249b966acda47ae3c08e5d31f1.tar.lz nixpkgs-0ac3e57ac1caa8249b966acda47ae3c08e5d31f1.tar.xz nixpkgs-0ac3e57ac1caa8249b966acda47ae3c08e5d31f1.tar.zst nixpkgs-0ac3e57ac1caa8249b966acda47ae3c08e5d31f1.zip |
nixos: nixos/doc/manual/administration/imperative-containers.xml to CommonMark
Diffstat (limited to 'nixos/doc/manual')
4 files changed, 247 insertions, 124 deletions
diff --git a/nixos/doc/manual/administration/containers.xml b/nixos/doc/manual/administration/containers.xml index 0d3355e56a5..0ea6844146e 100644 --- a/nixos/doc/manual/administration/containers.xml +++ b/nixos/doc/manual/administration/containers.xml @@ -28,7 +28,7 @@ contrast, in the imperative approach, containers are configured and updated independently from the host system. </para> - <xi:include href="imperative-containers.xml" /> + <xi:include href="../from_md/administration/imperative-containers.section.xml" /> <xi:include href="declarative-containers.xml" /> <xi:include href="container-networking.xml" /> </chapter> diff --git a/nixos/doc/manual/administration/imperative-containers.section.md b/nixos/doc/manual/administration/imperative-containers.section.md new file mode 100644 index 00000000000..05196bf5d81 --- /dev/null +++ b/nixos/doc/manual/administration/imperative-containers.section.md @@ -0,0 +1,115 @@ +# Imperative Container Management {#sec-imperative-containers} + +We'll cover imperative container management using `nixos-container` +first. Be aware that container management is currently only possible as +`root`. + +You create a container with identifier `foo` as follows: + +```ShellSession +# nixos-container create foo +``` + +This creates the container's root directory in `/var/lib/containers/foo` +and a small configuration file in `/etc/containers/foo.conf`. It also +builds the container's initial system configuration and stores it in +`/nix/var/nix/profiles/per-container/foo/system`. You can modify the +initial configuration of the container on the command line. For +instance, to create a container that has `sshd` running, with the given +public key for `root`: + +```ShellSession +# nixos-container create foo --config ' + services.openssh.enable = true; + users.users.root.openssh.authorizedKeys.keys = ["ssh-dss AAAAB3N…"]; +' +``` + +By default the next free address in the `10.233.0.0/16` subnet will be +chosen as container IP. This behavior can be altered by setting +`--host-address` and `--local-address`: + +```ShellSession +# nixos-container create test --config-file test-container.nix \ + --local-address 10.235.1.2 --host-address 10.235.1.1 +``` + +Creating a container does not start it. To start the container, run: + +```ShellSession +# nixos-container start foo +``` + +This command will return as soon as the container has booted and has +reached `multi-user.target`. On the host, the container runs within a +systemd unit called `container@container-name.service`. Thus, if +something went wrong, you can get status info using `systemctl`: + +```ShellSession +# systemctl status container@foo +``` + +If the container has started successfully, you can log in as root using +the `root-login` operation: + +```ShellSession +# nixos-container root-login foo +[root@foo:~]# +``` + +Note that only root on the host can do this (since there is no +authentication). You can also get a regular login prompt using the +`login` operation, which is available to all users on the host: + +```ShellSession +# nixos-container login foo +foo login: alice +Password: *** +``` + +With `nixos-container run`, you can execute arbitrary commands in the +container: + +```ShellSession +# nixos-container run foo -- uname -a +Linux foo 3.4.82 #1-NixOS SMP Thu Mar 20 14:44:05 UTC 2014 x86_64 GNU/Linux +``` + +There are several ways to change the configuration of the container. +First, on the host, you can edit +`/var/lib/container/name/etc/nixos/configuration.nix`, and run + +```ShellSession +# nixos-container update foo +``` + +This will build and activate the new configuration. You can also specify +a new configuration on the command line: + +```ShellSession +# nixos-container update foo --config ' + services.httpd.enable = true; + services.httpd.adminAddr = "foo@example.org"; + networking.firewall.allowedTCPPorts = [ 80 ]; +' + +# curl http://$(nixos-container show-ip foo)/ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">… +``` + +However, note that this will overwrite the container's +`/etc/nixos/configuration.nix`. + +Alternatively, you can change the configuration from within the +container itself by running `nixos-rebuild switch` inside the container. +Note that the container by default does not have a copy of the NixOS +channel, so you should run `nix-channel --update` first. + +Containers can be stopped and started using `nixos-container + stop` and `nixos-container start`, respectively, or by using +`systemctl` on the container's service unit. To destroy a container, +including its file system, do + +```ShellSession +# nixos-container destroy foo +``` diff --git a/nixos/doc/manual/administration/imperative-containers.xml b/nixos/doc/manual/administration/imperative-containers.xml deleted file mode 100644 index bc19acf9f69..00000000000 --- a/nixos/doc/manual/administration/imperative-containers.xml +++ /dev/null @@ -1,123 +0,0 @@ -<section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - version="5.0" - xml:id="sec-imperative-containers"> - <title>Imperative Container Management</title> - - <para> - We’ll cover imperative container management using - <command>nixos-container</command> first. Be aware that container management - is currently only possible as <literal>root</literal>. - </para> - - <para> - You create a container with identifier <literal>foo</literal> as follows: -<screen> -<prompt># </prompt>nixos-container create <replaceable>foo</replaceable> -</screen> - This creates the container’s root directory in - <filename>/var/lib/containers/<replaceable>foo</replaceable></filename> and a small configuration file - in <filename>/etc/containers/<replaceable>foo</replaceable>.conf</filename>. It also builds the - container’s initial system configuration and stores it in - <filename>/nix/var/nix/profiles/per-container/<replaceable>foo</replaceable>/system</filename>. You can - modify the initial configuration of the container on the command line. For - instance, to create a container that has <command>sshd</command> running, - with the given public key for <literal>root</literal>: -<screen> -<prompt># </prompt>nixos-container create <replaceable>foo</replaceable> --config ' - <xref linkend="opt-services.openssh.enable"/> = true; - <link linkend="opt-users.users._name_.openssh.authorizedKeys.keys">users.users.root.openssh.authorizedKeys.keys</link> = ["ssh-dss AAAAB3N…"]; -' -</screen> - By default the next free address in the <literal>10.233.0.0/16</literal> subnet will be chosen - as container IP. This behavior can be altered by setting <literal>--host-address</literal> and - <literal>--local-address</literal>: -<screen> -<prompt># </prompt>nixos-container create test --config-file test-container.nix \ - --local-address 10.235.1.2 --host-address 10.235.1.1 -</screen> - </para> - - <para> - Creating a container does not start it. To start the container, run: -<screen> -<prompt># </prompt>nixos-container start <replaceable>foo</replaceable> -</screen> - This command will return as soon as the container has booted and has reached - <literal>multi-user.target</literal>. On the host, the container runs within - a systemd unit called - <literal>container@<replaceable>container-name</replaceable>.service</literal>. - Thus, if something went wrong, you can get status info using - <command>systemctl</command>: -<screen> -<prompt># </prompt>systemctl status container@<replaceable>foo</replaceable> -</screen> - </para> - - <para> - If the container has started successfully, you can log in as root using the - <command>root-login</command> operation: -<screen> -<prompt># </prompt>nixos-container root-login <replaceable>foo</replaceable> -<prompt>[root@foo:~]#</prompt> -</screen> - Note that only root on the host can do this (since there is no - authentication). You can also get a regular login prompt using the - <command>login</command> operation, which is available to all users on the - host: -<screen> -<prompt># </prompt>nixos-container login <replaceable>foo</replaceable> -foo login: alice -Password: *** -</screen> - With <command>nixos-container run</command>, you can execute arbitrary - commands in the container: -<screen> -<prompt># </prompt>nixos-container run <replaceable>foo</replaceable> -- uname -a -Linux foo 3.4.82 #1-NixOS SMP Thu Mar 20 14:44:05 UTC 2014 x86_64 GNU/Linux -</screen> - </para> - - <para> - There are several ways to change the configuration of the container. First, - on the host, you can edit - <literal>/var/lib/container/<replaceable>name</replaceable>/etc/nixos/configuration.nix</literal>, - and run -<screen> -<prompt># </prompt>nixos-container update <replaceable>foo</replaceable> -</screen> - This will build and activate the new configuration. You can also specify a - new configuration on the command line: -<screen> -<prompt># </prompt>nixos-container update <replaceable>foo</replaceable> --config ' - <xref linkend="opt-services.httpd.enable"/> = true; - <xref linkend="opt-services.httpd.adminAddr"/> = "foo@example.org"; - <xref linkend="opt-networking.firewall.allowedTCPPorts"/> = [ 80 ]; -' - -<prompt># </prompt>curl http://$(nixos-container show-ip <replaceable>foo</replaceable>)/ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">… -</screen> - However, note that this will overwrite the container’s - <filename>/etc/nixos/configuration.nix</filename>. - </para> - - <para> - Alternatively, you can change the configuration from within the container - itself by running <command>nixos-rebuild switch</command> inside the - container. Note that the container by default does not have a copy of the - NixOS channel, so you should run <command>nix-channel --update</command> - first. - </para> - - <para> - Containers can be stopped and started using <literal>nixos-container - stop</literal> and <literal>nixos-container start</literal>, respectively, or - by using <command>systemctl</command> on the container’s service unit. To - destroy a container, including its file system, do -<screen> -<prompt># </prompt>nixos-container destroy <replaceable>foo</replaceable> -</screen> - </para> -</section> diff --git a/nixos/doc/manual/from_md/administration/imperative-containers.section.xml b/nixos/doc/manual/from_md/administration/imperative-containers.section.xml new file mode 100644 index 00000000000..59ecfdee5af --- /dev/null +++ b/nixos/doc/manual/from_md/administration/imperative-containers.section.xml @@ -0,0 +1,131 @@ +<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-imperative-containers"> + <title>Imperative Container Management</title> + <para> + We’ll cover imperative container management using + <literal>nixos-container</literal> first. Be aware that container + management is currently only possible as <literal>root</literal>. + </para> + <para> + You create a container with identifier <literal>foo</literal> as + follows: + </para> + <programlisting> +# nixos-container create foo +</programlisting> + <para> + This creates the container’s root directory in + <literal>/var/lib/containers/foo</literal> and a small configuration + file in <literal>/etc/containers/foo.conf</literal>. It also builds + the container’s initial system configuration and stores it in + <literal>/nix/var/nix/profiles/per-container/foo/system</literal>. + You can modify the initial configuration of the container on the + command line. For instance, to create a container that has + <literal>sshd</literal> running, with the given public key for + <literal>root</literal>: + </para> + <programlisting> +# nixos-container create foo --config ' + services.openssh.enable = true; + users.users.root.openssh.authorizedKeys.keys = ["ssh-dss AAAAB3N…"]; +' +</programlisting> + <para> + By default the next free address in the + <literal>10.233.0.0/16</literal> subnet will be chosen as container + IP. This behavior can be altered by setting + <literal>--host-address</literal> and + <literal>--local-address</literal>: + </para> + <programlisting> +# nixos-container create test --config-file test-container.nix \ + --local-address 10.235.1.2 --host-address 10.235.1.1 +</programlisting> + <para> + Creating a container does not start it. To start the container, run: + </para> + <programlisting> +# nixos-container start foo +</programlisting> + <para> + This command will return as soon as the container has booted and has + reached <literal>multi-user.target</literal>. On the host, the + container runs within a systemd unit called + <literal>container@container-name.service</literal>. Thus, if + something went wrong, you can get status info using + <literal>systemctl</literal>: + </para> + <programlisting> +# systemctl status container@foo +</programlisting> + <para> + If the container has started successfully, you can log in as root + using the <literal>root-login</literal> operation: + </para> + <programlisting> +# nixos-container root-login foo +[root@foo:~]# +</programlisting> + <para> + Note that only root on the host can do this (since there is no + authentication). You can also get a regular login prompt using the + <literal>login</literal> operation, which is available to all users + on the host: + </para> + <programlisting> +# nixos-container login foo +foo login: alice +Password: *** +</programlisting> + <para> + With <literal>nixos-container run</literal>, you can execute + arbitrary commands in the container: + </para> + <programlisting> +# nixos-container run foo -- uname -a +Linux foo 3.4.82 #1-NixOS SMP Thu Mar 20 14:44:05 UTC 2014 x86_64 GNU/Linux +</programlisting> + <para> + There are several ways to change the configuration of the container. + First, on the host, you can edit + <literal>/var/lib/container/name/etc/nixos/configuration.nix</literal>, + and run + </para> + <programlisting> +# nixos-container update foo +</programlisting> + <para> + This will build and activate the new configuration. You can also + specify a new configuration on the command line: + </para> + <programlisting> +# nixos-container update foo --config ' + services.httpd.enable = true; + services.httpd.adminAddr = "foo@example.org"; + networking.firewall.allowedTCPPorts = [ 80 ]; +' + +# curl http://$(nixos-container show-ip foo)/ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">… +</programlisting> + <para> + However, note that this will overwrite the container’s + <literal>/etc/nixos/configuration.nix</literal>. + </para> + <para> + Alternatively, you can change the configuration from within the + container itself by running <literal>nixos-rebuild switch</literal> + inside the container. Note that the container by default does not + have a copy of the NixOS channel, so you should run + <literal>nix-channel --update</literal> first. + </para> + <para> + Containers can be stopped and started using + <literal>nixos-container stop</literal> and + <literal>nixos-container start</literal>, respectively, or by using + <literal>systemctl</literal> on the container’s service unit. To + destroy a container, including its file system, do + </para> + <programlisting> +# nixos-container destroy foo +</programlisting> +</section> |